{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"complexType.UnitAndValue_double":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"number"}}},"complexType.UnitAndValue_long":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"integer"}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"hosting.web.AbuseState":{"type":"object","description":"abuse state","properties":{"accessState":{"allOf":[{"$ref":"#/components/schemas/hosting.web.AccessStateEnum"}],"description":"access state","readOnly":true},"mailsoutState":{"allOf":[{"$ref":"#/components/schemas/hosting.web.MailsoutStateEnum"}],"description":"mailsout state","readOnly":true},"outState":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OutStateEnum"}],"description":"TCP out state","readOnly":true},"webState":{"allOf":[{"$ref":"#/components/schemas/hosting.web.StateEnum"}],"description":"web state","readOnly":true}}},"hosting.web.AccessStateEnum":{"type":"string","description":"Hosting's web state","enum":["active","blocked","hardBlocked","hardMaintenance","maintenance"]},"hosting.web.Address":{"type":"object","description":"Url and port of a service","properties":{"port":{"type":"integer","description":"Port to use to access to the service"},"url":{"type":"string","description":"Url to contact the service"}}},"hosting.web.AvailableOfferStruct":{"type":"object","description":"Struct which describs an boost offer from a service","properties":{"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Available boost offer"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"The price in month for this boost offer"}}},"hosting.web.BoostHistory":{"type":"object","description":"Boost History","properties":{"accountId":{"type":"string","description":" Account who requested the change","readOnly":true},"boostOffer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Boost offer used","nullable":true,"readOnly":true},"date":{"type":"string","description":"The date when the change has been requested","format":"date-time","readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Offer when the change was made","readOnly":true}}},"hosting.web.CDN":{"type":"object","description":"CDN properties","properties":{"domain":{"type":"string","description":"Domain of this CDN","readOnly":true},"free":{"type":"boolean","description":"Whether CDN is free with the hosting","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.cdn.StatusEnum"}],"description":"Status of the CDN option","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this CDN","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the CDN","readOnly":true},"version":{"type":"string","description":"Version of the CDN","readOnly":true}}},"hosting.web.Capabilities":{"type":"object","description":"Struct which describs an offer","properties":{"attachedDomains":{"type":"integer","description":"Number of domains you can attach to your hosting"},"crontab":{"type":"boolean","description":"Does the offer allow crontab"},"databaseEngines":{"type":"integer","description":"Number of database engines allowed for your hosting"},"databases":{"type":"array","description":"Describe all databases type you can have","items":{"$ref":"#/components/schemas/hosting.web.database.CreationDatabaseCapabilities"}},"disk":{"allOf":[{"$ref":"#/components/schemas/hosting.web.DiskType"}],"description":"Disk capacity and type available for your hosting ( null for unlimited )","nullable":true},"emails":{"allOf":[{"$ref":"#/components/schemas/hosting.web.CreationEmailCapabilities"}],"description":"Describe all email offer you can have"},"envVars":{"type":"integer","description":"Number of environment variables allowed for your hosting"},"extraUsers":{"type":"integer","description":"Number of ftp user you can create"},"filesBrowser":{"type":"boolean","description":"Does the offer allow access to web files browser?"},"highlight":{"allOf":[{"$ref":"#/components/schemas/hosting.web.HighLightEnum"}],"description":"Marketing information about the current offer","nullable":true},"languages":{"allOf":[{"$ref":"#/components/schemas/hosting.web.CronLanguageAvailable"}],"description":"Language available for cron script"},"moduleOneClick":{"type":"boolean","description":"Does the offer allow 1-click modules?"},"privateDatabases":{"type":"array","description":"Describe all privateDatabases type you can have","items":{"$ref":"#/components/schemas/hosting.web.database.CreationDatabaseCapabilities"}},"runtimes":{"type":"integer","description":"Number of runtimes allowed for your hosting"},"sitesRecommended":{"type":"integer","description":"Number of sites recommended for your hosting ( -1 for unlimited )","nullable":true},"ssh":{"type":"boolean","description":"Does the offer allow SSH access"},"traffic":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Traffic quota size for your hosting ( null for unlimited )","nullable":true}}},"hosting.web.CountriesIp":{"type":"object","description":"Available clusterIp by country","properties":{"country":{"allOf":[{"$ref":"#/components/schemas/hosting.web.CountryEnum"}],"description":"The whois country of the ip","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"The cluster ip","nullable":true,"readOnly":true},"ipv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"The cluster ipv6","nullable":true,"readOnly":true}}},"hosting.web.CountryEnum":{"type":"string","description":"Available cluster countries","enum":["BE","CA","CZ","DE","ES","FI","FR","IE","IT","LT","NL","PL","PT","UK"]},"hosting.web.CreationEmailCapabilities":{"type":"object","description":"Struct which describes mail offer available and his quota","properties":{"available":{"type":"integer","description":"Number of email available for creation"},"quota":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Email account capacity"}}},"hosting.web.CronLanguageAvailable":{"type":"object","description":"Language available for cron script","properties":{"nodejs":{"type":"array","description":"NodeJS versions","items":{"$ref":"#/components/schemas/hosting.web.NodejsVersionAvailableEnum"}},"php":{"type":"array","description":"Php versions","items":{"$ref":"#/components/schemas/hosting.web.PhpVersionAvailableEnum"}},"python":{"type":"array","description":"Python versions","items":{"$ref":"#/components/schemas/hosting.web.PythonVersionAvailableEnum"}},"ruby":{"type":"array","description":"Ruby versions","items":{"$ref":"#/components/schemas/hosting.web.RubyVersionAvailableEnum"}}}},"hosting.web.DiskType":{"type":"object","description":"Disk properties (size and type of disk)","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.DiskTypeEnum"}],"description":"Type of the disk"},"unit":{"type":"string","description":"Unit for disk size"},"value":{"type":"number","description":"Size of the disk"}}},"hosting.web.DiskTypeEnum":{"type":"string","description":"Disk type available","enum":["HDD","SSD"]},"hosting.web.HighLightEnum":{"type":"string","description":"Highlight tips for offer","enum":["best-seller","new"]},"hosting.web.MailsoutStateEnum":{"type":"string","description":"Hosting's mailsout state","enum":["bounce","ko","ok","spam","spamLegalBlocked"]},"hosting.web.MetricsToken":{"type":"object","description":"Metrics token","properties":{"endpoint":{"type":"string","description":"Backend url","readOnly":true},"expiry":{"type":"string","description":"Token expiration date","format":"date-time","readOnly":true},"token":{"type":"string","description":"Generated token","format":"password","readOnly":true}}},"hosting.web.NodejsVersionAvailableEnum":{"type":"string","description":"Different NodeJs versions available","enum":["nodejs-10","nodejs-11","nodejs-12","nodejs-8","nodejs-9"]},"hosting.web.OfferCapabilitiesEnum":{"type":"string","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"]},"hosting.web.OfferEnum":{"type":"string","description":"Hosting's offer","enum":["CLOUDWEB_1","CLOUDWEB_2","CLOUDWEB_3","KS","PERFORMANCE_1","PERFORMANCE_2","PERFORMANCE_3","PERFORMANCE_4","PERSO","POWER_BETA_1","PRO","START","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"]},"hosting.web.OperatingSystemEnum":{"type":"string","description":"Hosting's OS","enum":["linux"]},"hosting.web.OutStateEnum":{"type":"string","description":"Hosting's out state","enum":["active","blocked","hardBlocked"]},"hosting.web.OvhConfigCapabilities":{"type":"object","description":"Struct which describes version and container image available","properties":{"containerImage":{"type":"array","description":"Container image available","items":{"type":"string"}},"version":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.AvailableEngineVersionEnum"}],"description":"PHP version"}}},"hosting.web.OvhConfigRecommendedValues":{"type":"object","description":"Struct which recommend default values on ovhConfig file","properties":{"container":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhconfig.ContainerEnum"}],"description":"Container to run this website"},"engineName":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.EngineNameEnum"}],"description":"Engine name"},"engineVersion":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.AvailableEngineVersionEnum"}],"description":"PHP version"},"environment":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.EnvironmentEnum"}],"description":"Environment configuration"},"httpFirewall":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.HttpFirewallEnum"}],"description":"Configuration for http firewall"}}},"hosting.web.PhpVersion":{"type":"object","description":"State of available php versions for this account","properties":{"support":{"allOf":[{"$ref":"#/components/schemas/hosting.web.PhpVersionStateEnum"}],"description":"Current support of this php version"},"version":{"type":"string","description":"PHP version"}}},"hosting.web.PhpVersionAvailableEnum":{"type":"string","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"]},"hosting.web.PhpVersionStateEnum":{"type":"string","description":"Different support of PHP versions","enum":["BETA","END_OF_LIFE","SECURITY_FIXES","SUPPORTED"]},"hosting.web.PublicTask":{"type":"object","description":"Public task","properties":{"doneDate":{"type":"string","description":"Done date","nullable":true,"format":"date-time","readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.FunctionEnum"}],"description":"Task function","readOnly":true},"id":{"type":"integer","description":"Task's id","readOnly":true},"lastUpdate":{"type":"string","description":"Last update date","nullable":true,"format":"date-time","readOnly":true},"objectId":{"type":"string","description":"Task object id","nullable":true,"readOnly":true},"objectType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.ObjectTypeEnum"}],"description":"Task object type","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Start date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.StatusEnum"}],"description":"Task status","readOnly":true}}},"hosting.web.PythonVersionAvailableEnum":{"type":"string","description":"Different Python versions available","enum":["python-2","python-3"]},"hosting.web.RequestActionEnum":{"type":"string","description":"Types of action you can request for your web hosting","enum":["CHECK_QUOTA","FLUSH_CACHE","SCAN_ANTIHACK"]},"hosting.web.RequestBoostInput":{"type":"object","description":"RequestBoost input properties","properties":{"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Requested boost offer","nullable":true}}},"hosting.web.ResourceEnum":{"type":"string","description":"Hosting's type","enum":["bestEffort","cloud","dedicated","shared"]},"hosting.web.RubyVersionAvailableEnum":{"type":"string","description":"Different Ruby versions available","enum":["ruby-2.6"]},"hosting.web.Service":{"type":"object","description":"Web Hosting","properties":{"availableBoostOffer":{"type":"array","description":"Available offers for boost option","items":{"$ref":"#/components/schemas/hosting.web.AvailableOfferStruct"},"readOnly":true},"boostOffer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Current boost offer","nullable":true,"readOnly":true},"cluster":{"type":"string","description":"Cluster name","readOnly":true},"clusterIp":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"This direct ip to your cluster ( usefull for application like api )","nullable":true,"readOnly":true},"clusterIpv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"This direct ipv6 to your cluster ( usefull for application like api )","nullable":true,"readOnly":true},"countriesIp":{"type":"array","description":"Available clusterIp by countries","nullable":true,"items":{"$ref":"#/components/schemas/hosting.web.CountriesIp"},"readOnly":true},"datacenter":{"type":"string","description":"Datacenter where this account is located","readOnly":true},"defaultAttachedDomain":{"type":"string","description":"The default attached domain created along with your hosting","nullable":true,"readOnly":true},"displayName":{"type":"string","description":"Set the name displayed in ManagerV6 for your hosting (max 50 chars)","nullable":true},"filer":{"type":"string","description":"Filer name","nullable":true,"readOnly":true},"hasCdn":{"type":"boolean","description":"Has a CDN service linked on the hosting","nullable":true,"readOnly":true},"hasHostedSsl":{"type":"boolean","description":"Has a HostedSSL service linked on the hosting","nullable":true,"readOnly":true},"home":{"type":"string","description":"Path of your home","readOnly":true},"hostingIp":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","nullable":true,"readOnly":true},"hostingIpv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","nullable":true,"readOnly":true},"lastOvhConfigScan":{"type":"string","description":"/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data","nullable":true,"format":"date-time","readOnly":true},"multipleSSL":{"type":"boolean","description":"If set to true, service can manage more than only one certificate","readOnly":true},"objectQuota":{"type":"number","description":"objects allowed","nullable":true,"readOnly":true},"objectUsed":{"type":"number","description":"objects used","nullable":true,"readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Hosting offer","readOnly":true},"operatingSystem":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OperatingSystemEnum"}],"description":"Hosting's OS","readOnly":true},"phpVersions":{"type":"array","description":"State of available php versions for this account","items":{"$ref":"#/components/schemas/hosting.web.PhpVersion"},"readOnly":true},"primaryLogin":{"type":"string","description":"Hosting's main login","readOnly":true},"quotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space allowed","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space used","nullable":true,"readOnly":true},"recommendedOffer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"If your offer is old, return a recommended offer to migrate on","nullable":true,"readOnly":true},"resourceType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ResourceEnum"}],"description":"Hosting resource type","readOnly":true},"serviceManagementAccess":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ServiceAccess"}],"description":"URLs to use to manage your webhosting","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.web.StateEnum"}],"description":"State of your hosting","readOnly":true},"token":{"type":"string","description":"Use to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )","nullable":true,"readOnly":true},"trafficQuotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Traffic quota allowed ( null = unlimited )","nullable":true,"readOnly":true},"trafficQuotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Traffic quota used","nullable":true,"readOnly":true},"updates":{"type":"array","description":"List of updates on your hosting","items":{"type":"string"},"readOnly":true}}},"hosting.web.ServiceAccess":{"type":"object","description":"Different url to manage your service","properties":{"ftp":{"allOf":[{"$ref":"#/components/schemas/hosting.web.Address"}],"description":"Address with url and port to manage files by ftp"},"http":{"allOf":[{"$ref":"#/components/schemas/hosting.web.Address"}],"description":"Address to see your webhosting without domain"},"ssh":{"allOf":[{"$ref":"#/components/schemas/hosting.web.Address"}],"description":"Address with url and port to manage webhosting by ssh"}}},"hosting.web.ServiceWithIAM":{"type":"object","description":"Web Hosting","properties":{"availableBoostOffer":{"type":"array","description":"Available offers for boost option","items":{"$ref":"#/components/schemas/hosting.web.AvailableOfferStruct"},"readOnly":true},"boostOffer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Current boost offer","nullable":true,"readOnly":true},"cluster":{"type":"string","description":"Cluster name","readOnly":true},"clusterIp":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"This direct ip to your cluster ( usefull for application like api )","nullable":true,"readOnly":true},"clusterIpv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"This direct ipv6 to your cluster ( usefull for application like api )","nullable":true,"readOnly":true},"countriesIp":{"type":"array","description":"Available clusterIp by countries","nullable":true,"items":{"$ref":"#/components/schemas/hosting.web.CountriesIp"},"readOnly":true},"datacenter":{"type":"string","description":"Datacenter where this account is located","readOnly":true},"defaultAttachedDomain":{"type":"string","description":"The default attached domain created along with your hosting","nullable":true,"readOnly":true},"displayName":{"type":"string","description":"Set the name displayed in ManagerV6 for your hosting (max 50 chars)","nullable":true},"filer":{"type":"string","description":"Filer name","nullable":true,"readOnly":true},"hasCdn":{"type":"boolean","description":"Has a CDN service linked on the hosting","nullable":true,"readOnly":true},"hasHostedSsl":{"type":"boolean","description":"Has a HostedSSL service linked on the hosting","nullable":true,"readOnly":true},"home":{"type":"string","description":"Path of your home","readOnly":true},"hostingIp":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","nullable":true,"readOnly":true},"hostingIpv6":{"allOf":[{"$ref":"#/components/schemas/ipv6"}],"description":"The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )","nullable":true,"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"lastOvhConfigScan":{"type":"string","description":"/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data","nullable":true,"format":"date-time","readOnly":true},"multipleSSL":{"type":"boolean","description":"If set to true, service can manage more than only one certificate","readOnly":true},"objectQuota":{"type":"number","description":"objects allowed","nullable":true,"readOnly":true},"objectUsed":{"type":"number","description":"objects used","nullable":true,"readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"Hosting offer","readOnly":true},"operatingSystem":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OperatingSystemEnum"}],"description":"Hosting's OS","readOnly":true},"phpVersions":{"type":"array","description":"State of available php versions for this account","items":{"$ref":"#/components/schemas/hosting.web.PhpVersion"},"readOnly":true},"primaryLogin":{"type":"string","description":"Hosting's main login","readOnly":true},"quotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space allowed","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space used","nullable":true,"readOnly":true},"recommendedOffer":{"allOf":[{"$ref":"#/components/schemas/hosting.web.OfferEnum"}],"description":"If your offer is old, return a recommended offer to migrate on","nullable":true,"readOnly":true},"resourceType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ResourceEnum"}],"description":"Hosting resource type","readOnly":true},"serviceManagementAccess":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ServiceAccess"}],"description":"URLs to use to manage your webhosting","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.web.StateEnum"}],"description":"State of your hosting","readOnly":true},"token":{"type":"string","description":"Use to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )","nullable":true,"readOnly":true},"trafficQuotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Traffic quota allowed ( null = unlimited )","nullable":true,"readOnly":true},"trafficQuotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Traffic quota used","nullable":true,"readOnly":true},"updates":{"type":"array","description":"List of updates on your hosting","items":{"type":"string"},"readOnly":true}}},"hosting.web.StateEnum":{"type":"string","description":"Hosting's state","enum":["active","blocked","bloqued","hardBlocked","hardBloqued","maintenance"]},"hosting.web.backup.TypeEnum":{"type":"string","description":"List of backup types","enum":["daily.1","daily.2","daily.3","weekly.1","weekly.2"]},"hosting.web.cdn.StatusEnum":{"type":"string","description":"CDN status","enum":["created","creating","deleting","flushing","reopening","suspended","suspending"]},"hosting.web.configuration":{"type":"object","description":"The Configuration of an hosting Power offer","properties":{"appEnv":{"allOf":[{"$ref":"#/components/schemas/hosting.web.configuration.EnvEnum"}],"description":"Application environment"},"entryPoint":{"type":"string","description":"Application launch script","nullable":true},"id":{"type":"integer","description":"Id of the current configuration","readOnly":true},"language":{"allOf":[{"$ref":"#/components/schemas/hosting.web.configuration.LanguageEnum"}],"description":"language chosen for the current hosting"},"publicDir":{"type":"string","description":"Directory of the application","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.configuration.StateEnum"}],"description":"Status of current configuration","readOnly":true},"version":{"type":"string","description":"version of the language chosen for the current hosting"}}},"hosting.web.configuration.EnvEnum":{"type":"string","description":"Configuration env enum","enum":["development","production"]},"hosting.web.configuration.LanguageEnum":{"type":"string","description":"Configuration languages enum","enum":["nodejs","python","ruby"]},"hosting.web.configuration.StateEnum":{"type":"string","description":"Configuration state enum","enum":["created","creating","deleting","updating"]},"hosting.web.configuration.VersionEnum":{"type":"string","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"]},"hosting.web.database.CreationDatabaseCapabilities":{"type":"object","description":"Struct which describs quota and available for a specific type of database","properties":{"available":{"type":"integer","description":"Number of database left for creation"},"engines":{"type":"array","description":"Database software available on this platform","items":{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}},"isolation":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseIsolationEnum"}],"description":"Technology use to isolate differents webhosting accounts"},"quota":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Size of data can be used"},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseCapabilitiesTypeEnum"}],"description":"Database offer name"}}},"hosting.web.database.DatabaseCapabilitiesTypeEnum":{"type":"string","description":"Database capabitities type enum","enum":["extraSqlPerso","local","privateDatabase","sqlLocal","sqlPerso","sqlPro"]},"hosting.web.database.DatabaseIsolationEnum":{"type":"string","description":"Database Isolation enum","enum":["dedicated","local","shared"]},"hosting.web.database.DatabaseTypeEnum":{"type":"string","description":"Database Type enum","enum":["mariadb","mongodb","mysql","postgresql","redis"]},"hosting.web.email":{"type":"object","description":"Hosting automated emails","properties":{"bounce":{"type":"integer","description":"Bounce","readOnly":true},"email":{"type":"string","description":"Email used to receive errors","nullable":true},"maxPerDay":{"type":"integer","description":"Max email to sent per day","readOnly":true},"sent":{"type":"integer","description":"Email sent since hosting creation","readOnly":true},"sentToday":{"type":"integer","description":"Email sent today","readOnly":true},"spoofing":{"type":"integer","description":"Spoofing Bounce","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.web.mail.StateEnum"}],"description":"Email state","readOnly":true}}},"hosting.web.emailoption":{"type":"object","description":"Mail service linked to webhosting","properties":{"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"domain":{"type":"string","description":"Email service domain","readOnly":true},"id":{"type":"integer","description":"Account id","readOnly":true}}},"hosting.web.freedom.StatusEnum":{"type":"string","description":"FreeDom status","enum":["blockedByCustomer","blockedBySystem","ok","preset"]},"hosting.web.mail.ActionEnum":{"type":"string","description":"Types of action you can request for your mail","enum":["BLOCK","PURGE","UNBLOCK"]},"hosting.web.mail.Bounce":{"type":"object","description":"The volume history type","properties":{"date":{"type":"string","description":"The datetime of this bounce","format":"date-time"},"isSpoofing":{"type":"boolean","description":"Whether this bounce is spoofing or not"},"message":{"type":"string","description":"The return message for this bounce","nullable":true},"to":{"type":"string","description":"The email where you have the bounce","nullable":true}}},"hosting.web.mail.StateEnum":{"type":"string","description":"Mail state enum","enum":["bounce","force","ko","ok","purging","spam"]},"hosting.web.mail.VolumeHistory":{"type":"object","description":"The volume history type","properties":{"date":{"type":"string","description":"The datetime of this volume history point","format":"date-time"},"volume":{"type":"integer","description":"The volume history size","nullable":true}}},"hosting.web.ovhConfig":{"type":"object","description":"Virtual service","properties":{"container":{"type":"string","description":"Container to run this website","readOnly":true},"creationDate":{"type":"string","description":"When ovhconfig was created, or found for the first time, on the hosting servers","format":"date-time","readOnly":true},"engineName":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.EngineNameEnum"}],"description":"Version of engine you want","readOnly":true},"engineVersion":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.EngineVersionEnum"}],"description":"Name of engine you want","readOnly":true},"environment":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.EnvironmentEnum"}],"description":"Environment configuration you want","readOnly":true},"fileExist":{"type":"boolean","description":"If .ovhConfig exists","readOnly":true},"historical":{"type":"boolean","description":"If this configuration is an old configuration","nullable":true,"readOnly":true},"httpFirewall":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.HttpFirewallEnum"}],"description":"Configuration you want for http firewall","readOnly":true},"id":{"type":"integer","description":"Configuration's id","readOnly":true},"path":{"type":"string","description":"Config path, relative to your home directory","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.ovhConfig.StatusEnum"}],"description":"The configuration status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this configuration","nullable":true,"readOnly":true}}},"hosting.web.ovhConfig.AvailableEngineVersionEnum":{"type":"string","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"]},"hosting.web.ovhConfig.EngineNameEnum":{"type":"string","description":"Hosting configuration engine","enum":["php","phpcgi"]},"hosting.web.ovhConfig.EngineVersionEnum":{"type":"string","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"]},"hosting.web.ovhConfig.EnvironmentEnum":{"type":"string","description":"Hosting configuration environment","enum":["development","production"]},"hosting.web.ovhConfig.HttpFirewallEnum":{"type":"string","description":"Hosting configuration firewall","enum":["none","security"]},"hosting.web.ovhConfig.StatusEnum":{"type":"string","description":"Ovhconfig status","enum":["created","rollbacking","updating"]},"hosting.web.ovhconfig.ContainerEnum":{"type":"string","description":"Hosting configuration image to run website","enum":["jessie.i386","legacy","stable","stable64","testing"]},"hosting.web.runtime":{"type":"object","description":"The runtime configuration of an attached domain for cloud web offer","properties":{"appBootstrap":{"type":"string","description":"The client application bootstrap script","nullable":true},"appEnv":{"allOf":[{"$ref":"#/components/schemas/hosting.web.runtime.EnvEnum"}],"description":"The client application environment"},"creationDate":{"type":"string","description":"The creation date of the runtime configuration","format":"date-time","readOnly":true},"id":{"type":"integer","description":"The runtime configuration ID","readOnly":true},"isDefault":{"type":"boolean","description":"Is the runtime configuration is the one by default for the hosting"},"isDeletable":{"type":"boolean","description":"Return if the runtime configuration can be deleted","readOnly":true},"lastUpdate":{"type":"string","description":"The last update date of the runtime configuration","format":"date-time","readOnly":true},"name":{"type":"string","description":"The custom display name of the runtime configuration","nullable":true},"publicDir":{"type":"string","description":"The client application public directory","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.runtime.StateEnum"}],"description":"The status of the runtime","readOnly":true},"taskId":{"type":"integer","description":"The link current task for the runtime configuration","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.runtime.TypeEnum"}],"description":"The backend type of the runtime"}}},"hosting.web.runtime.EnvEnum":{"type":"string","description":"Runtime env enum","enum":["development","production"]},"hosting.web.runtime.StateEnum":{"type":"string","description":"Runtime state enum","enum":["created","creating","deleting","updating"]},"hosting.web.runtime.TypeEnum":{"type":"string","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"]},"hosting.web.task":{"type":"object","description":"Tasks","properties":{"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"type":"string","description":"Function name","readOnly":true},"id":{"type":"integer","description":"the id of the task","readOnly":true},"lastUpdate":{"type":"string","description":"last update","nullable":true,"format":"date-time","readOnly":true},"objectId":{"type":"string","description":"Task related object ID","nullable":true,"readOnly":true},"objectType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.ObjectTypeEnum"}],"description":"Task object type","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Task Creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.StatusEnum"}],"description":"Task status","readOnly":true}}},"hosting.web.task.FunctionEnum":{"type":"string","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"]},"hosting.web.task.ObjectTypeEnum":{"type":"string","description":"Task object type listing","enum":["Abuse","AttachedDomain","BlockedIp","Cdn","Cron","Database","Dump","EnvVar","Filerz","Hostedssl","Hosting","Indy","Infra","Minor","Module","Other","OvhConfig","OvhOrg","OwnLogs","Runtime","Scan","Sqlperso","User","UserLogs","Web","Webd"]},"hosting.web.task.StatusEnum":{"type":"string","description":"Task's status","enum":["cancelled","doing","done","error","init","todo"]},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"order.CurrencyCodeEnum":{"type":"string","description":"Currency code","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"]},"order.Price":{"type":"object","description":"Price with its currency and textual representation","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/order.CurrencyCodeEnum"}],"description":"Currency code","readOnly":true},"priceInUcents":{"type":"integer","description":"Price in microcents","nullable":true,"readOnly":true},"text":{"type":"string","description":"Textual representation","readOnly":true},"value":{"type":"number","description":"The effective price","readOnly":true}}},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"service.TerminationFutureUseEnum":{"type":"string","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"]},"service.TerminationReasonEnum":{"type":"string","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"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"services.changeContact":{"type":"object","description":"Service change contact payload","properties":{"contactAdmin":{"type":"string","description":"The contact to set as admin contact"},"contactBilling":{"type":"string","description":"The contact to set as billing contact"},"contactTech":{"type":"string","description":"The contact to set as tech contact"}}},"services.confirmTermination":{"type":"object","description":"Service confirm termination payload","properties":{"commentary":{"type":"string","description":"Commentary about your termination request"},"commentaryFutureUse":{"type":"string","description":"Commentary about your future use"},"commentaryReason":{"type":"string","description":"Commentary about your reason for termination request"},"futureUse":{"allOf":[{"$ref":"#/components/schemas/service.TerminationFutureUseEnum"}],"description":"All future uses you can provide for a service termination"},"reason":{"allOf":[{"$ref":"#/components/schemas/service.TerminationReasonEnum"}],"description":"All reasons you can provide for a service termination"},"token":{"type":"string","description":"The termination token sent by email to the admin contact"}},"required":["token"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/hosting/web":{"get":{"summary":"List web hostings","description":"Returns the service names of the web hostings of the account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:get","required":true}],"x-expanded-response":"HostingWebServiceWithIAM"}},"/hosting/web/availableOffer":{"get":{"summary":"List available offers","description":"List available offers. Returns the offers that can be ordered for the given domain, to create a new hosting or upgrade an existing one.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"domain","description":"Domain you want to add or upgrade a hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.OfferEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/availableOffer\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/availableOffer\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:webHosting/availableOffer/get","required":true}]}},"/hosting/web/incident":{"get":{"summary":"List current incidents","description":"List current incidents. Returns the incidents in progress on the web hosting platform that can affect the hosting services.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/incident\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/incident\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:webHosting/incident/get","required":true}]}},"/hosting/web/offerCapabilities":{"get":{"summary":"Get offer capabilities","description":"Get offer capabilities. Returns what an offer includes: attached domains, databases, disk, traffic, SSH, cron, modules and runtimes.","parameters":[{"in":"query","name":"offer","description":"Describe offer capabilities","required":true,"schema":{"$ref":"#/components/schemas/hosting.web.OfferCapabilitiesEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.Capabilities"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/offerCapabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/offerCapabilities\");\n\nprint_r($result);\n?>"}]}},"/hosting/web/{serviceName}":{"get":{"summary":"Get a web hosting","description":"Returns the offer, state, cluster, recommended IPs, disk and traffic quotas, and PHP versions of the web hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.ServiceWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:get","required":true}]},"put":{"summary":"Update a web hosting","description":"Updates the display name of the web hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@400"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.Service\nresult = client.put(\"/hosting/web/{serviceName}\",\n\tdisplayName = None, # Set the name displayed in ManagerV6 for your hosting (max 50 chars) (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.Service\n$result = $ovh->put(\"/hosting/web/{serviceName}\", array(\n\tdisplayName => null, // Set the name displayed in ManagerV6 for your hosting (max 50 chars) (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:edit","required":true}]}},"/hosting/web/{serviceName}/abuseState":{"get":{"summary":"Get the abuse state","description":"Returns the access, web, outgoing email and outgoing TCP states of the hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.AbuseState"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/abuseState\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/abuseState\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:abuseState/get","required":true}]}},"/hosting/web/{serviceName}/availableConfigurations":{"get":{"summary":"List available configurations","description":"List available configurations. Returns the language versions available for the application configuration. Filter them by language.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"language","description":"Filter on language name","schema":{"$ref":"#/components/schemas/hosting.web.configuration.LanguageEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.configuration.VersionEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/availableConfigurations\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/availableConfigurations\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:availableConfigurations/get","required":true}]}},"/hosting/web/{serviceName}/boostHistory":{"get":{"summary":"List boost history","description":"Returns the dates of the boost changes of the hosting. Filter them by date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"date","description":"Filter the value of date property (=)","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"date-time"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/boostHistory\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/boostHistory\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:boostHistory/get","required":true}],"x-expanded-response":"HostingWebBoostHistory"}},"/hosting/web/{serviceName}/boostHistory/{date}":{"get":{"summary":"Get a boost history entry","description":"Returns the boost offer, the hosting offer at that time, the requesting account and the request date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"date","description":"Date","required":true,"schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.BoostHistory"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/boostHistory/{date}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/boostHistory/{date}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:boostHistory/get","required":true}],"x-response-identifier":"date"}},"/hosting/web/{serviceName}/cdn":{"get":{"summary":"Get the CDN","description":"Returns the domain, type, version and status of the CDN option, and whether it is free with the hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.CDN"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/cdn\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/cdn\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/get","required":true}],"x-response-identifier":"domain"}},"/hosting/web/{serviceName}/cdn/serviceInfos":{"get":{"summary":"Get CDN service information","description":"Get CDN service information. Returns the billing information of the CDN option: creation and expiration dates, renewal settings and contacts.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/cdn/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/cdn/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/serviceInfos/get","required":true}]}},"/hosting/web/{serviceName}/cdn/serviceInfosUpdate":{"post":{"summary":"Update CDN renewal","description":"Update CDN renewal. Updates the renewal settings of the CDN option: automatic renewal, renewal period and deletion at expiration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"renew":{"description":"Renew type","$ref":"#/components/schemas/service.RenewType"}},"required":["renew"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@250"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: service.RenewType\nresult = client.post(\"/hosting/web/{serviceName}/cdn/serviceInfosUpdate\",\n\trenew = None, # Renew type (type: service.RenewType)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: service.RenewType\n$result = $ovh->post(\"/hosting/web/{serviceName}/cdn/serviceInfosUpdate\", array(\n\trenew => null, // Renew type (type: service.RenewType)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/serviceInfosUpdate/create","required":true}]}},"/hosting/web/{serviceName}/cdn/terminate":{"post":{"summary":"Terminate the CDN option","description":"Terminate the CDN option. Requests the termination of the CDN option. A link to confirm it is sent by email to the administrator contact.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@260"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/hosting/web/{serviceName}/cdn/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/hosting/web/{serviceName}/cdn/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:cdn/terminate","required":true}]}},"/hosting/web/{serviceName}/changeContact":{"post":{"summary":"Change contacts","description":"Starts the contact change procedure of the service. Returns the identifiers of the created tasks.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.changeContact"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@270"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: services.changeContact\nresult = client.post(\"/hosting/web/{serviceName}/changeContact\",\n\tcontactAdmin = None, # The contact to set as admin contact (type: string)\n\tcontactBilling = None, # The contact to set as billing contact (type: string)\n\tcontactTech = None, # The contact to set as tech contact (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: services.changeContact\n$result = $ovh->post(\"/hosting/web/{serviceName}/changeContact\", array(\n\tcontactAdmin => null, // The contact to set as admin contact (type: string)\n\tcontactBilling => null, // The contact to set as billing contact (type: string)\n\tcontactTech => null, // The contact to set as tech contact (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:changeContact","required":true}]}},"/hosting/web/{serviceName}/configuration":{"get":{"summary":"Get the configuration","description":"Get the configuration. Returns the language, version, environment, launch script and public directory of the application.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.configuration"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@130"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/configuration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/configuration\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:configuration/get","required":true}]},"put":{"summary":"Update the configuration","description":"Update the configuration. Updates the language, version, environment, launch script or public directory of the application.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.configuration"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@410"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.configuration\nresult = client.put(\"/hosting/web/{serviceName}/configuration\",\n\tappEnv = None, # Application environment (type: hosting.web.configuration.EnvEnum)\n\tentryPoint = None, # Application launch script (type: string, nullable)\n\tlanguage = None, # language chosen for the current hosting (type: hosting.web.configuration.LanguageEnum)\n\tpublicDir = None, # Directory of the application (type: string, nullable)\n\tversion = None, # version of the language chosen for the current hosting (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.configuration\n$result = $ovh->put(\"/hosting/web/{serviceName}/configuration\", array(\n\tappEnv => null, // Application environment (type: hosting.web.configuration.EnvEnum)\n\tentryPoint => null, // Application launch script (type: string, nullable)\n\tlanguage => null, // language chosen for the current hosting (type: hosting.web.configuration.LanguageEnum)\n\tpublicDir => null, // Directory of the application (type: string, nullable)\n\tversion => null, // version of the language chosen for the current hosting (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:configuration/edit","required":true}]}},"/hosting/web/{serviceName}/confirmTermination":{"post":{"summary":"Confirm termination","description":"Confirms the termination of the service with the token sent by email.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.confirmTermination"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@280"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: services.confirmTermination\nresult = client.post(\"/hosting/web/{serviceName}/confirmTermination\",\n\tcommentary = None, # Commentary about your termination request (type: string)\n\tcommentaryFutureUse = None, # Commentary about your future use (type: string)\n\tcommentaryReason = None, # Commentary about your reason for termination request (type: string)\n\tfutureUse = None, # All future uses you can provide for a service termination (type: service.TerminationFutureUseEnum)\n\treason = None, # All reasons you can provide for a service termination (type: service.TerminationReasonEnum)\n\ttoken = None, # The termination token sent by email to the admin contact (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: services.confirmTermination\n$result = $ovh->post(\"/hosting/web/{serviceName}/confirmTermination\", array(\n\tcommentary => null, // Commentary about your termination request (type: string)\n\tcommentaryFutureUse => null, // Commentary about your future use (type: string)\n\tcommentaryReason => null, // Commentary about your reason for termination request (type: string)\n\tfutureUse => null, // All future uses you can provide for a service termination (type: service.TerminationFutureUseEnum)\n\treason => null, // All reasons you can provide for a service termination (type: service.TerminationReasonEnum)\n\ttoken => null, // The termination token sent by email to the admin contact (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:confirmTermination","required":true}]}},"/hosting/web/{serviceName}/email":{"get":{"summary":"Get the email state","description":"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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.email"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/email\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/email\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:email/get","required":true}]},"put":{"summary":"Update the email settings","description":"Update the email settings. Updates the email address that receives the sending errors of the hosting scripts. The other fields are read-only.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.email"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@420"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.email\nresult = client.put(\"/hosting/web/{serviceName}/email\",\n\temail = None, # Email used to receive errors (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.email\n$result = $ovh->put(\"/hosting/web/{serviceName}/email\", array(\n\temail => null, // Email used to receive errors (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:email/edit","required":true}]}},"/hosting/web/{serviceName}/email/bounces":{"get":{"summary":"List email bounces","description":"List email bounces. Returns the last bounces of the emails sent by the hosting: 20 by default, 100 at most with limit.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"limit","description":"Maximum bounces limit ( default : 20 / max : 100 )","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.mail.Bounce"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/email/bounces\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/email/bounces\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:email/bounces/get","required":true}]}},"/hosting/web/{serviceName}/email/request":{"post":{"summary":"Run an email action","description":"Run an email action. Blocks or unblocks the emails sent by the hosting scripts, or purges the queue of emails waiting to be sent.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"description":"Action you want to request","$ref":"#/components/schemas/hosting.web.mail.ActionEnum"}},"required":["action"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@290"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.mail.ActionEnum\nresult = client.post(\"/hosting/web/{serviceName}/email/request\",\n\taction = None, # Action you want to request (type: hosting.web.mail.ActionEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.mail.ActionEnum\n$result = $ovh->post(\"/hosting/web/{serviceName}/email/request\", array(\n\taction => null, // Action you want to request (type: hosting.web.mail.ActionEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:email/request/create","required":true}]}},"/hosting/web/{serviceName}/email/volumes":{"get":{"summary":"Get email volume history","description":"Get email volume history. Returns the number of emails sent by the hosting scripts over time, as a list of dated volume points.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.mail.VolumeHistory"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/email/volumes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/email/volumes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:email/volumes/get","required":true}]}},"/hosting/web/{serviceName}/emailOption":{"get":{"summary":"List email options","description":"List email options. Returns the IDs of the email options of the hosting. Each option is a mail service linked to the hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/emailOption\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/emailOption\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:emailOption/get","required":true}],"x-expanded-response":"HostingWebEmailoption"}},"/hosting/web/{serviceName}/emailOption/{id}":{"get":{"summary":"Get an email option","description":"Get an email option. Returns the domain and creation date of the email option. Its billing information is returned by serviceInfos.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.emailoption"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/emailOption/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/emailOption/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:emailOption/get","required":true}]}},"/hosting/web/{serviceName}/emailOption/{id}/serviceInfos":{"get":{"summary":"Get email option service information","description":"Get email option service information. Returns the billing information of the email option: creation and expiration dates, renewal settings and contacts.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/emailOption/{id}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/emailOption/{id}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:emailOption/serviceInfos/get","required":true}]}},"/hosting/web/{serviceName}/emailOption/{id}/terminate":{"post":{"summary":"Terminate an email option","description":"Terminate an email option. Requests the termination of the email option. A link to confirm it is sent by email to the administrator contact.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@300"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/hosting/web/{serviceName}/emailOption/{id}/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/hosting/web/{serviceName}/emailOption/{id}/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:emailOption/terminate","required":true}]}},"/hosting/web/{serviceName}/freedom":{"get":{"summary":"List free domains","description":"Returns the free domain names included with the hosting offer. Filter them by status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the freedom status (=)","schema":{"$ref":"#/components/schemas/hosting.web.freedom.StatusEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/freedom\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/freedom\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:freedom/get","required":true}]}},"/hosting/web/{serviceName}/metricsToken":{"get":{"summary":"Get a metrics token","description":"Returns a token to read the hosting metrics, the endpoint to query and the token expiration date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.MetricsToken"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@170"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/metricsToken\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/metricsToken\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:metricsToken/get","required":true}]}},"/hosting/web/{serviceName}/ovhConfig":{"get":{"summary":"List .ovhconfig files","description":"List .ovhconfig files. Returns the IDs of the .ovhconfig configurations of the hosting. Filter them by path, or by historical to include old ones.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"historical","description":"Filter the value of historical property (=)","schema":{"type":"boolean"}},{"in":"query","name":"path","description":"Filter the value of path property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/ovhConfig\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/ovhConfig\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfig/get","required":true}],"x-expanded-response":"HostingWebOvhConfig"}},"/hosting/web/{serviceName}/ovhConfig/{id}":{"get":{"summary":"Get a .ovhconfig file","description":"Get a .ovhconfig file. Returns the engine, version, container, environment, HTTP firewall and status of the configuration of a folder.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Configuration's id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.ovhConfig"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/ovhConfig/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/ovhConfig/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfig/get","required":true}]}},"/hosting/web/{serviceName}/ovhConfig/{id}/changeConfiguration":{"post":{"summary":"Change a .ovhconfig file","description":"Change a .ovhconfig file. Applies a new engine, version, container, environment or HTTP firewall setting to the folder, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Configuration's id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"container":{"description":"Container to run this website","$ref":"#/components/schemas/hosting.web.ovhconfig.ContainerEnum"},"engineName":{"description":"Version of engine you want","$ref":"#/components/schemas/hosting.web.ovhConfig.EngineNameEnum"},"engineVersion":{"description":"Name of engine you want","$ref":"#/components/schemas/hosting.web.ovhConfig.AvailableEngineVersionEnum"},"environment":{"description":"Environment configuration you want","$ref":"#/components/schemas/hosting.web.ovhConfig.EnvironmentEnum"},"httpFirewall":{"description":"Configuration you want for http firewall","$ref":"#/components/schemas/hosting.web.ovhConfig.HttpFirewallEnum"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@310"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.ovhConfig.HttpFirewallEnum\nresult = client.post(\"/hosting/web/{serviceName}/ovhConfig/{id}/changeConfiguration\",\n\tcontainer = None, # Container to run this website (type: hosting.web.ovhconfig.ContainerEnum, nullable)\n\tengineName = None, # Version of engine you want (type: hosting.web.ovhConfig.EngineNameEnum, nullable)\n\tengineVersion = None, # Name of engine you want (type: hosting.web.ovhConfig.AvailableEngineVersionEnum, nullable)\n\tenvironment = None, # Environment configuration you want (type: hosting.web.ovhConfig.EnvironmentEnum, nullable)\n\thttpFirewall = None, # Configuration you want for http firewall (type: hosting.web.ovhConfig.HttpFirewallEnum, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.ovhConfig.HttpFirewallEnum\n$result = $ovh->post(\"/hosting/web/{serviceName}/ovhConfig/{id}/changeConfiguration\", array(\n\tcontainer => null, // Container to run this website (type: hosting.web.ovhconfig.ContainerEnum, nullable)\n\tengineName => null, // Version of engine you want (type: hosting.web.ovhConfig.EngineNameEnum, nullable)\n\tengineVersion => null, // Name of engine you want (type: hosting.web.ovhConfig.AvailableEngineVersionEnum, nullable)\n\tenvironment => null, // Environment configuration you want (type: hosting.web.ovhConfig.EnvironmentEnum, nullable)\n\thttpFirewall => null, // Configuration you want for http firewall (type: hosting.web.ovhConfig.HttpFirewallEnum, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfig/changeConfiguration","required":true}]}},"/hosting/web/{serviceName}/ovhConfig/{id}/rollback":{"post":{"summary":"Roll back a .ovhconfig file","description":"Roll back a .ovhconfig file. Restores the old configuration given by rollbackId and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Configuration's id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rollbackId":{"type":"integer","description":"The configuration's id you want to rollback"}},"required":["rollbackId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@310"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: long\nresult = client.post(\"/hosting/web/{serviceName}/ovhConfig/{id}/rollback\",\n\trollbackId = None, # The configuration's id you want to rollback (type: long)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: long\n$result = $ovh->post(\"/hosting/web/{serviceName}/ovhConfig/{id}/rollback\", array(\n\trollbackId => null, // The configuration's id you want to rollback (type: long)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfig/rollback","required":true}]}},"/hosting/web/{serviceName}/ovhConfigCapabilities":{"get":{"summary":"List .ovhconfig capabilities","description":"List .ovhconfig capabilities. Returns the PHP versions and container images available on the hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.OvhConfigCapabilities"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/ovhConfigCapabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/ovhConfigCapabilities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfigCapabilities/get","required":true}]}},"/hosting/web/{serviceName}/ovhConfigRecommendedValues":{"get":{"summary":"Get recommended .ovhconfig values","description":"Get recommended .ovhconfig values. Returns the recommended engine, version, container, environment and HTTP firewall for the .ovhconfig file.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.OvhConfigRecommendedValues"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/ovhConfigRecommendedValues\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/ovhConfigRecommendedValues\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfigRecommendedValues/get","required":true}]}},"/hosting/web/{serviceName}/ovhConfigRefresh":{"post":{"summary":"Refresh .ovhconfig files","description":"Refresh .ovhconfig files. Synchronizes the list of configurations with the .ovhconfig files on the hosting, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@320"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/hosting/web/{serviceName}/ovhConfigRefresh\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/hosting/web/{serviceName}/ovhConfigRefresh\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ovhConfig/refresh","required":true}]}},"/hosting/web/{serviceName}/request":{"post":{"summary":"Run an action","description":"Run an action. Checks the quota, flushes the cache or runs an antihack scan on the hosting, and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"description":"Action you want to request","$ref":"#/components/schemas/hosting.web.RequestActionEnum"}},"required":["action"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@330"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.RequestActionEnum\nresult = client.post(\"/hosting/web/{serviceName}/request\",\n\taction = None, # Action you want to request (type: hosting.web.RequestActionEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.RequestActionEnum\n$result = $ovh->post(\"/hosting/web/{serviceName}/request\", array(\n\taction => null, // Action you want to request (type: hosting.web.RequestActionEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:request","required":true}]}},"/hosting/web/{serviceName}/requestBoost":{"post":{"summary":"Request a boost","description":"Applies the requested boost offer to the hosting and returns the task. Send a null offer to disable the boost.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.RequestBoostInput"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@340"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.RequestBoostInput\nresult = client.post(\"/hosting/web/{serviceName}/requestBoost\",\n\toffer = None, # Requested boost offer (type: hosting.web.OfferEnum, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.RequestBoostInput\n$result = $ovh->post(\"/hosting/web/{serviceName}/requestBoost\", array(\n\toffer => null, // Requested boost offer (type: hosting.web.OfferEnum, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:requestBoost","required":true}]}},"/hosting/web/{serviceName}/restoreSnapshot":{"post":{"summary":"Restore a backup","description":"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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"backup":{"description":"The backup you want to restore","$ref":"#/components/schemas/hosting.web.backup.TypeEnum"}},"required":["backup"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@350"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.backup.TypeEnum\nresult = client.post(\"/hosting/web/{serviceName}/restoreSnapshot\",\n\tbackup = None, # The backup you want to restore (type: hosting.web.backup.TypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.backup.TypeEnum\n$result = $ovh->post(\"/hosting/web/{serviceName}/restoreSnapshot\", array(\n\tbackup => null, // The backup you want to restore (type: hosting.web.backup.TypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:restoreSnapshot","required":true}]}},"/hosting/web/{serviceName}/runtime":{"get":{"summary":"List runtime configurations","description":"List runtime configurations. Returns the IDs of the runtime configurations of the hosting. Filter them by name or type.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"name","description":"Filter the value of name property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Filter the value of type property (=)","schema":{"$ref":"#/components/schemas/hosting.web.runtime.TypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@210"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/runtime\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/runtime\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/get","required":true}],"x-expanded-response":"HostingWebRuntime"},"post":{"summary":"Create a runtime configuration","description":"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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"appBootstrap":{"type":"string","description":"The client application bootstrap script"},"appEnv":{"description":"The client application environment","$ref":"#/components/schemas/hosting.web.runtime.EnvEnum"},"attachedDomains":{"type":"array","description":"The attached domains fqdn to link to this runtime configuration","items":{"type":"string"}},"isDefault":{"type":"boolean","description":"Set if the runtime configuration is the one by default for the hosting"},"name":{"type":"string","description":"The custom display name of the runtime configuration"},"publicDir":{"type":"string","description":"The client application public directory"},"type":{"description":"The backend type of a runtime configuration","$ref":"#/components/schemas/hosting.web.runtime.TypeEnum"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@360"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.runtime.TypeEnum\nresult = client.post(\"/hosting/web/{serviceName}/runtime\",\n\tappBootstrap = None, # The client application bootstrap script (type: string, nullable)\n\tappEnv = None, # The client application environment (type: hosting.web.runtime.EnvEnum, nullable)\n\tattachedDomains = None, # The attached domains fqdn to link to this runtime configuration (type: string[], nullable)\n\tisDefault = None, # Set if the runtime configuration is the one by default for the hosting (type: boolean, nullable)\n\tname = None, # The custom display name of the runtime configuration (type: string, nullable)\n\tpublicDir = None, # The client application public directory (type: string, nullable)\n\ttype = None, # The backend type of a runtime configuration (type: hosting.web.runtime.TypeEnum, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.runtime.TypeEnum\n$result = $ovh->post(\"/hosting/web/{serviceName}/runtime\", array(\n\tappBootstrap => null, // The client application bootstrap script (type: string, nullable)\n\tappEnv => null, // The client application environment (type: hosting.web.runtime.EnvEnum, nullable)\n\tattachedDomains => null, // The attached domains fqdn to link to this runtime configuration (type: string[], nullable)\n\tisDefault => null, // Set if the runtime configuration is the one by default for the hosting (type: boolean, nullable)\n\tname => null, // The custom display name of the runtime configuration (type: string, nullable)\n\tpublicDir => null, // The client application public directory (type: string, nullable)\n\ttype => null, // The backend type of a runtime configuration (type: hosting.web.runtime.TypeEnum, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/create","required":true}]}},"/hosting/web/{serviceName}/runtime/{id}":{"delete":{"summary":"Delete a runtime configuration","description":"Delete a runtime configuration. Deletes the runtime configuration and returns the task. Only a configuration with isDeletable set to true can be deleted.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"The runtime configuration ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@390"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/hosting/web/{serviceName}/runtime/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/hosting/web/{serviceName}/runtime/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/delete","required":true}]},"get":{"summary":"Get a runtime configuration","description":"Get a runtime configuration. Returns the backend type, environment, bootstrap script, public directory and status of the runtime configuration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"The runtime configuration ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.runtime"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@210"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/runtime/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/runtime/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/get","required":true}]},"put":{"summary":"Update a runtime configuration","description":"Update a runtime configuration. Updates the name, backend type, environment, bootstrap script, public directory or default status of the runtime configuration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"The runtime configuration ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.runtime"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@430"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.web.runtime\nresult = client.put(\"/hosting/web/{serviceName}/runtime/{id}\",\n\tappBootstrap = None, # The client application bootstrap script (type: string, nullable)\n\tappEnv = None, # The client application environment (type: hosting.web.runtime.EnvEnum)\n\tisDefault = None, # Is the runtime configuration is the one by default for the hosting (type: boolean)\n\tname = None, # The custom display name of the runtime configuration (type: string, nullable)\n\tpublicDir = None, # The client application public directory (type: string, nullable)\n\ttype = None, # The backend type of the runtime (type: hosting.web.runtime.TypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.web.runtime\n$result = $ovh->put(\"/hosting/web/{serviceName}/runtime/{id}\", array(\n\tappBootstrap => null, // The client application bootstrap script (type: string, nullable)\n\tappEnv => null, // The client application environment (type: hosting.web.runtime.EnvEnum)\n\tisDefault => null, // Is the runtime configuration is the one by default for the hosting (type: boolean)\n\tname => null, // The custom display name of the runtime configuration (type: string, nullable)\n\tpublicDir => null, // The client application public directory (type: string, nullable)\n\ttype => null, // The backend type of the runtime (type: hosting.web.runtime.TypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/edit","required":true}]}},"/hosting/web/{serviceName}/runtime/{id}/attachedDomains":{"get":{"summary":"List runtime configuration domains","description":"List runtime configuration domains. Returns the attached domains that use the runtime configuration. Link a domain to it with its runtimeId.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"The runtime configuration ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@210"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/runtime/{id}/attachedDomains\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/runtime/{id}/attachedDomains\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtime/attachedDomains/get","required":true}]}},"/hosting/web/{serviceName}/runtimeAvailableTypes":{"get":{"summary":"List runtime backend types","description":"List runtime backend types. Returns the backend types available for runtime configurations. Filter them by programming language.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"language","description":"Specific programming language to filter","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.runtime.TypeEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@220"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/runtimeAvailableTypes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/runtimeAvailableTypes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:runtimeAvailableTypes/get","required":true}]}},"/hosting/web/{serviceName}/serviceInfos":{"get":{"summary":"Get service information","description":"Returns the billing information of the service: creation and expiration dates, renewal settings and contacts.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@230"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/web/{serviceName}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:serviceInfos/get","required":true}]},"put":{"summary":"Update service information","description":"Updates the renewal settings of the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@440"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: services.Service\nresult = client.put(\"/hosting/web/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: services.Service\n$result = $ovh->put(\"/hosting/web/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:serviceInfos/edit","required":true}]}},"/hosting/web/{serviceName}/terminate":{"post":{"summary":"Request termination","description":"Requests the termination of the service. Confirm it with confirmTermination and the token sent by email.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@370"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/hosting/web/{serviceName}/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/hosting/web/{serviceName}/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:terminate","required":true}]}},"/hosting/web/{serviceName}/unblockTCPOut":{"post":{"summary":"Unblock outgoing TCP","description":"Requests the unblocking of the outgoing TCP connections of the hosting, blocked after an abuse. Their current state is outState in the abuse state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting@@@380"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/hosting/web/{serviceName}/unblockTCPOut\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/hosting/web/{serviceName}/unblockTCPOut\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:unblockTCPOut","required":true}]}}}}