{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"hosting.web.AttachedDomain":{"type":"object","description":"Attached domain","properties":{"bypassDNSConfiguration":{"type":"boolean","description":"If set to true, DNS zone will not be updated by the operation","nullable":true},"cdn":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.CdnEnum"}],"description":"Whether the attached domain is linked to the hosting CDN","nullable":true},"domain":{"type":"string","description":"Domain to link","nullable":true},"firewall":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.FirewallEnum"}],"description":"Whether the firewall is active for this domain","nullable":true},"ipLocation":{"allOf":[{"$ref":"#/components/schemas/hosting.web.CountryEnum"}],"description":"Change attached domain's DNS to the IP of the country","nullable":true},"ownLog":{"type":"string","description":"Domain to separate the logs on","nullable":true},"path":{"type":"string","description":"Path of the attached domain","nullable":true},"runtimeId":{"type":"integer","description":"The runtime configuration ID used on this domain","nullable":true},"ssl":{"type":"boolean","description":"Whether to put the attached domain in the SSL certificate","nullable":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.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.SSL":{"type":"object","description":"Hosted SSL properties","properties":{"isReportable":{"type":"boolean","description":"If the hostedssl is currently bound to a report","readOnly":true},"provider":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ProviderEnum"}],"description":"Provider of the Hosted SSL","readOnly":true},"regenerable":{"type":"boolean","description":"Regenerable flag","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.StatusEnum"}],"description":"Status of the Hosted SSL","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this Hosted SSL","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.TypeEnum"}],"description":"Type of the Hosted SSL","readOnly":true}}},"hosting.web.SSLUpdateInput":{"type":"object","description":"SSL update input properties","properties":{"regenerate":{"type":"boolean","description":"true to regenerate the certificate"}}},"hosting.web.SupportedVcsEnum":{"type":"string","description":"Supported VCS platforms","enum":["github"]},"hosting.web.VcsWebhooks":{"type":"object","description":"VCS webhooks URLs for given hosting and VCS platform","properties":{"push":{"type":"string","description":"Webhook URL for push events","readOnly":true}}},"hosting.web.Website":{"type":"object","description":"A website on your hosting","properties":{"domains":{"type":"array","description":"Domains of the website","items":{"$ref":"#/components/schemas/hosting.web.website.Domain"},"readOnly":true},"hostingDisplayName":{"type":"string","description":"Display name of the hosting","readOnly":true},"hostingServiceName":{"type":"string","description":"Name of the hosting service","readOnly":true},"id":{"type":"integer","description":"Website numeric identifier","readOnly":true},"name":{"type":"string","description":"Customizable name of the website","nullable":true,"readOnly":true},"path":{"type":"string","description":"Relative path on the hosting filesystem the website is deployed into","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.website.StatusEnum"}],"description":"Current status of the website","readOnly":true},"vcsBranch":{"type":"string","description":"Branch of the repository containing the website source code to deploy","readOnly":true},"vcsUrl":{"type":"string","description":"URL of the repository containing the website source code to deploy","readOnly":true}}},"hosting.web.WebsiteCreationCapabilities":{"type":"object","description":"Website creation capabilities of your hosting","properties":{"allowedVcsWebsites":{"type":"integer","description":"Number of websites deployed from a Git repository allowed by your hosting offer, -1 meaning unlimited","nullable":true,"readOnly":true},"allowedWebsites":{"type":"integer","description":"Number of websites allowed by your hosting offer, Git-deployed or not, -1 meaning unlimited","readOnly":true},"existingVcsWebsites":{"type":"integer","description":"Number of existing websites deployed from a Git repository on your hosting","nullable":true,"readOnly":true},"existingWebsites":{"type":"integer","description":"Number of existing websites on your hosting, Git-deployed or not","readOnly":true}}},"hosting.web.attachedDomain.Capabilities":{"type":"object","description":"Attached domain Capability","properties":{"description":{"type":"string","description":"Capability description","readOnly":true},"href":{"type":"string","description":"Capability href","readOnly":true},"key":{"type":"string","description":"Capability key","readOnly":true},"method":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.CapabilityMethodEnum"}],"description":"Capability method","readOnly":true}}},"hosting.web.attachedDomain.CapabilityMethodEnum":{"type":"string","description":"allowed attachedDomain's capabilities methods","enum":["DELETE","GET","POST","PUT"]},"hosting.web.attachedDomain.CdnEnum":{"type":"string","description":"whether or not the attachedDomain is linked to the hosting cdn","enum":["active","none"]},"hosting.web.attachedDomain.DigStatus":{"type":"object","description":"Attached domain DNS status","properties":{"domain":{"type":"string","description":"Attached domain","readOnly":true},"recommendedIps":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.RecommendedIps"}],"readOnly":true},"records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/hosting.web.attachedDomain.RecordStatus"},"readOnly":true}}},"hosting.web.attachedDomain.FirewallEnum":{"type":"string","description":"Firewall state for this path","enum":["active","none"]},"hosting.web.attachedDomain.PublicAttachedDomain":{"type":"object","description":"Public attached domain","properties":{"capabilities":{"type":"array","description":"Provides the capabilities related to your attachedDomain","items":{"$ref":"#/components/schemas/hosting.web.attachedDomain.Capabilities"},"readOnly":true},"cdn":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.CdnEnum"}],"description":"whether or not attachedDomain is linked to the hosting cdn","readOnly":true},"domain":{"type":"string","description":"Domain linked (fqdn)","readOnly":true},"firewall":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.FirewallEnum"}],"description":"Firewall state for this path","readOnly":true},"ipLocation":{"allOf":[{"$ref":"#/components/schemas/hosting.web.CountryEnum"}],"description":"IP location of the domain linked","nullable":true,"readOnly":true},"isFlushable":{"type":"boolean","description":"Whether your CDN can be flushed","readOnly":true},"ownLog":{"type":"string","description":"Domain for separate the logs","nullable":true,"readOnly":true},"path":{"type":"string","description":"Attached domain path","readOnly":true},"runtimeId":{"type":"integer","description":"The runtime configuration ID used on this domain","nullable":true,"readOnly":true},"ssl":{"type":"boolean","description":"Put domain in SSL certificate","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.StatusEnum"}],"description":"Domain status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this domain","nullable":true,"readOnly":true},"vcsStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.VcsStatusEnum"}],"description":"The status of the VCS synchronization","readOnly":true}}},"hosting.web.attachedDomain.RecommendedIps":{"type":"object","description":"Recommended IPs for DNS records configuration","properties":{"recommendedIpV4":{"type":"array","description":"Recommended IPV4","items":{"$ref":"#/components/schemas/ipv4"},"readOnly":true},"recommendedIpV6":{"type":"array","description":"Recommended IPV6","items":{"$ref":"#/components/schemas/ipv6"},"readOnly":true}}},"hosting.web.attachedDomain.RecordStatus":{"type":"object","description":"Attached domain record status","properties":{"dnsConfigured":{"type":"boolean","description":"Whether DNS is configured","readOnly":true},"isOvhIp":{"type":"boolean","description":"Whether IP is an OVH one","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.attachedDomain.RecordTypeEnum"}],"description":"DNS record type","readOnly":true}}},"hosting.web.attachedDomain.RecordTypeEnum":{"type":"string","description":"DNS Record type","enum":["A","AAAA","CAA"]},"hosting.web.attachedDomain.StatusEnum":{"type":"string","description":"attachedDomain status","enum":["created","creating","deleting","updating"]},"hosting.web.attachedDomain.VcsStatusEnum":{"type":"string","description":"AttachedDomain vcs status","enum":["created","creating","deleting","deploying","disabled","error","initialError"]},"hosting.web.hostedssl.ProviderEnum":{"type":"string","description":"Hosted SSL Provider","enum":["COMODO","CUSTOM","LETSENCRYPT","SECTIGO"]},"hosting.web.hostedssl.ReportStatusEnum":{"type":"string","description":"Hosted SSL report status","enum":["completed","in-progress","non-completed","non-required","not-applicable","not-provided"]},"hosting.web.hostedssl.StatusEnum":{"type":"string","description":"Hosted SSL status","enum":["created","creating","deleting","importing","regenerating"]},"hosting.web.hostedssl.TypeEnum":{"type":"string","description":"Hosted SSL type","enum":["CUSTOM","DV","EV"]},"hosting.web.ssl.Report":{"type":"object","description":"Hosted SSL report","properties":{"certificateSigningRequestStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"\"Certificate signing request\" test status done by certification authority","readOnly":true},"domainControlValidationStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"\"Domain control validation\" test status done by certification authority","readOnly":true},"organizationValidationStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"Applicant's legal status obtained or verified directly with registration agency","readOnly":true},"phoneCallApprovalStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"Approval verified through a phone call to the contract signer","readOnly":true},"providerOrderId":{"type":"string","description":"The order ID from given hostedssl provider","readOnly":true},"termsAndConditionsAcceptanceStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"Terms and conditions agreements acceptance","readOnly":true},"tradeNameVerificationStatus":{"allOf":[{"$ref":"#/components/schemas/hosting.web.hostedssl.ReportStatusEnum"}],"description":"Trade name verified directly with registration agency or through a verified third party","readOnly":true}}},"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"]},"hosting.web.website.CreationRequest":{"type":"object","description":"Information needed to create a new website","properties":{"path":{"type":"string","description":"Relative path on the hosting filesystem the website will be deployed into"},"vcsBranch":{"type":"string","description":"Branch of the repository containing the website source code to deploy"},"vcsUrl":{"type":"string","description":"Clone URL of the repository containing the website source code to deploy"}},"required":["path","vcsBranch","vcsUrl"]},"hosting.web.website.Deployment":{"type":"object","description":"A website deployment","properties":{"date":{"type":"string","description":"Date of the deployment","format":"date-time","readOnly":true},"id":{"type":"integer","description":"Deployment numeric identifier","readOnly":true},"reset":{"type":"boolean","description":"Whether a reset was requested before deploying","readOnly":true},"source":{"type":"string","description":"Source which triggered the deployment","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.website.deployment.StatusEnum"}],"description":"Current status of the deployment","readOnly":true},"vcsBranch":{"type":"string","description":"Which branch of the repository is deployed","readOnly":true},"vcsCommitId":{"type":"string","description":"Identifier of the last commit after deployment","nullable":true,"readOnly":true},"vcsCommitMessage":{"type":"string","description":"Message of the last commit after deployment","nullable":true,"readOnly":true},"websiteId":{"type":"integer","description":"Website numeric identifier","readOnly":true}}},"hosting.web.website.DeploymentRequest":{"type":"object","description":"Information needed to request deployment of a website","properties":{"reset":{"type":"boolean","description":"Whether a reset was requested before deploying"}}},"hosting.web.website.Domain":{"type":"object","description":"A website domain","properties":{"cdn":{"type":"boolean","description":"If the CDN is currently active","readOnly":true},"fqdn":{"type":"string","description":"FQDN of the website domain","readOnly":true},"ssl":{"type":"boolean","description":"If the SSL is currently active","readOnly":true}}},"hosting.web.website.StatusEnum":{"type":"string","description":"Website status","enum":["created","creating","deleting","deploying","error","initialError"]},"hosting.web.website.Update":{"type":"object","description":"Information to update on a website","properties":{"vcsBranch":{"type":"string","description":"Branch of the repository containing the website source code to deploy","nullable":true}}},"hosting.web.website.deployment.LogsMessage":{"type":"object","description":"Message from logs of a website deployment","properties":{"date":{"type":"string","description":"Date of the message","format":"date-time","readOnly":true},"message":{"type":"string","description":"Content of the message","readOnly":true}}},"hosting.web.website.deployment.StatusEnum":{"type":"string","description":"Website deployment status","enum":["doing","failed","successful"]},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/hosting/web/attachedDomain":{"get":{"summary":"Find hostings by attached domain","description":"Returns the service names of the hostings that have the given domain attached.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"domain","description":"Domain used into web hosting attached domains","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","My sites@@@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/attachedDomain\")\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/attachedDomain\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:webHosting/attachedDomain/get","required":true}]}},"/hosting/web/vcs/supported":{"get":{"summary":"List supported VCS platforms","description":"Returns the VCS platforms a website can be deployed from.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.SupportedVcsEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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/vcs/supported\")\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/vcs/supported\");\n\nprint_r($result);\n?>"}]}},"/hosting/web/{serviceName}/attachedDomain":{"get":{"summary":"List attached domains","description":"Returns the domains and subdomains attached to the hosting. Filter them by domain or path.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"domain","description":"Filter the value of domain property (like)","schema":{"type":"string"}},{"in":"query","name":"path","description":"Filter the value of path property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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/{serviceName}/attachedDomain\")\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}/attachedDomain\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/get","required":true}],"x-expanded-response":"HostingWebAttachedDomainPublicAttachedDomain"},"post":{"summary":"Attach a domain","description":"Attaches a domain to a folder of the hosting, with its CDN, firewall, SSL and IP location settings, and returns the task. Set bypassDNSConfiguration to true to leave the DNS zone unchanged.","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.AttachedDomain"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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\n# Request body type: hosting.web.AttachedDomain\nresult = client.post(\"/hosting/web/{serviceName}/attachedDomain\",\n\tbypassDNSConfiguration = None, # If set to true, DNS zone will not be updated by the operation (type: boolean, nullable)\n\tcdn = None, # Whether the attached domain is linked to the hosting CDN (type: hosting.web.attachedDomain.CdnEnum, nullable)\n\tdomain = None, # Domain to link (type: string, nullable)\n\tfirewall = None, # Whether the firewall is active for this domain (type: hosting.web.attachedDomain.FirewallEnum, nullable)\n\tipLocation = None, # Change attached domain's DNS to the IP of the country (type: hosting.web.CountryEnum, nullable)\n\townLog = None, # Domain to separate the logs on (type: string, nullable)\n\tpath = None, # Path of the attached domain (type: string, nullable)\n\truntimeId = None, # The runtime configuration ID used on this domain (type: integer, nullable)\n\tssl = None, # Whether to put the attached domain in the SSL certificate (type: boolean, 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.AttachedDomain\n$result = $ovh->post(\"/hosting/web/{serviceName}/attachedDomain\", array(\n\tbypassDNSConfiguration => null, // If set to true, DNS zone will not be updated by the operation (type: boolean, nullable)\n\tcdn => null, // Whether the attached domain is linked to the hosting CDN (type: hosting.web.attachedDomain.CdnEnum, nullable)\n\tdomain => null, // Domain to link (type: string, nullable)\n\tfirewall => null, // Whether the firewall is active for this domain (type: hosting.web.attachedDomain.FirewallEnum, nullable)\n\tipLocation => null, // Change attached domain's DNS to the IP of the country (type: hosting.web.CountryEnum, nullable)\n\townLog => null, // Domain to separate the logs on (type: string, nullable)\n\tpath => null, // Path of the attached domain (type: string, nullable)\n\truntimeId => null, // The runtime configuration ID used on this domain (type: integer, nullable)\n\tssl => null, // Whether to put the attached domain in the SSL certificate (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/create","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}":{"delete":{"summary":"Detach a domain","description":"Detaches the domain from the hosting and returns the task. Set bypassDNSConfiguration to true to leave the DNS zone unchanged.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"bypassDNSConfiguration","description":"If set to true, DNS zone will not be updated by the operation","schema":{"type":"boolean"}},{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.delete(\"/hosting/web/{serviceName}/attachedDomain/{domain}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/hosting/web/{serviceName}/attachedDomain/{domain}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/delete","required":true}]},"get":{"summary":"Get an attached domain","description":"Returns the path, CDN, firewall, SSL, IP location and status of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.attachedDomain.PublicAttachedDomain"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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/{serviceName}/attachedDomain/{domain}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/attachedDomain/{domain}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/get","required":true}],"x-response-identifier":"domain"},"put":{"summary":"Update an attached domain","description":"Updates the path, CDN, firewall, SSL, IP location or log domain of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.AttachedDomain"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.AttachedDomain\nresult = client.put(\"/hosting/web/{serviceName}/attachedDomain/{domain}\",\n\tbypassDNSConfiguration = None, # If set to true, DNS zone will not be updated by the operation (type: boolean, nullable)\n\tcdn = None, # Whether the attached domain is linked to the hosting CDN (type: hosting.web.attachedDomain.CdnEnum, nullable)\n\tdomain = None, # Domain to link (type: string, nullable)\n\tfirewall = None, # Whether the firewall is active for this domain (type: hosting.web.attachedDomain.FirewallEnum, nullable)\n\tipLocation = None, # Change attached domain's DNS to the IP of the country (type: hosting.web.CountryEnum, nullable)\n\townLog = None, # Domain to separate the logs on (type: string, nullable)\n\tpath = None, # Path of the attached domain (type: string, nullable)\n\truntimeId = None, # The runtime configuration ID used on this domain (type: integer, nullable)\n\tssl = None, # Whether to put the attached domain in the SSL certificate (type: boolean, 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.AttachedDomain\n$result = $ovh->put(\"/hosting/web/{serviceName}/attachedDomain/{domain}\", array(\n\tbypassDNSConfiguration => null, // If set to true, DNS zone will not be updated by the operation (type: boolean, nullable)\n\tcdn => null, // Whether the attached domain is linked to the hosting CDN (type: hosting.web.attachedDomain.CdnEnum, nullable)\n\tdomain => null, // Domain to link (type: string, nullable)\n\tfirewall => null, // Whether the firewall is active for this domain (type: hosting.web.attachedDomain.FirewallEnum, nullable)\n\tipLocation => null, // Change attached domain's DNS to the IP of the country (type: hosting.web.CountryEnum, nullable)\n\townLog => null, // Domain to separate the logs on (type: string, nullable)\n\tpath => null, // Path of the attached domain (type: string, nullable)\n\truntimeId => null, // The runtime configuration ID used on this domain (type: integer, nullable)\n\tssl => null, // Whether to put the attached domain in the SSL certificate (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/edit","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}/digStatus":{"get":{"summary":"Get attached domain DNS status","description":"Returns the DNS records of the attached domain, their status and the recommended IPs to point them to.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.attachedDomain.DigStatus"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/attachedDomain/{domain}/digStatus\")\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}/attachedDomain/{domain}/digStatus\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/digStatus/get","required":true}],"x-response-identifier":"domain"}},"/hosting/web/{serviceName}/attachedDomain/{domain}/purgeCache":{"post":{"summary":"Purge the attached domain cache","description":"Purge the attached domain cache. Purges the CDN cache of the attached domain and returns the task. Available when isFlushable is true on the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain linked (fqdn)","required":true,"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":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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\nresult = client.post(\"/hosting/web/{serviceName}/attachedDomain/{domain}/purgeCache\")\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}/attachedDomain/{domain}/purgeCache\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/purgeCache","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}/restart":{"post":{"summary":"Restart the attached domain virtual host","description":"Restart the attached domain virtual host. Restarts the virtual host serving the attached domain and returns the task.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain linked (fqdn)","required":true,"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":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/attachedDomain/{domain}/restart\")\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}/attachedDomain/{domain}/restart\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:attachedDomain/restart","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl":{"delete":{"summary":"Delete the SSL certificate","description":"Deletes the SSL certificate of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSL"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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\nresult = client.delete(\"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl\")\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}/attachedDomain/{domain}/ssl\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/delete","required":true}]},"get":{"summary":"Get the SSL certificate","description":"Returns the provider, type and status of the SSL certificate of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSL"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/attachedDomain/{domain}/ssl\")\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}/attachedDomain/{domain}/ssl\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/get","required":true}]},"post":{"summary":"Create a free SSL certificate","description":"Creates the free Let's Encrypt SSL certificate of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSL"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.post(\"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl\")\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}/attachedDomain/{domain}/ssl\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/create","required":true}]},"put":{"summary":"Update the SSL certificate","description":"Updates the SSL certificate of the attached domain. Set regenerate to true to regenerate it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSLUpdateInput"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSL"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.SSLUpdateInput\nresult = client.put(\"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl\",\n\tregenerate = None, # true to regenerate the certificate (type: boolean)\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.SSLUpdateInput\n$result = $ovh->put(\"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl\", array(\n\tregenerate => null, // true to regenerate the certificate (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/edit","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl/regenerate":{"post":{"summary":"Regenerate the SSL certificate","description":"Regenerates the SSL certificate of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.SSL"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@240"]],"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}/attachedDomain/{domain}/ssl/regenerate\")\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}/attachedDomain/{domain}/ssl/regenerate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/regenerate","required":true}]}},"/hosting/web/{serviceName}/attachedDomain/{domain}/ssl/report":{"get":{"summary":"Get the SSL certificate report","description":"Returns the status of each validation check run by the certification authority for the certificate of the attached domain.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"domain","description":"Domain","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.ssl.Report"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/attachedDomain/{domain}/ssl/report\")\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}/attachedDomain/{domain}/ssl/report\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:ssl/report/get","required":true}]}},"/hosting/web/{serviceName}/token":{"get":{"summary":"Get the domain ownership token","description":"Get the domain ownership token. Returns the token that proves the ownership of an external domain. Add it in a TXT record of the ovhcontrol subdomain in the DNS zone.","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","My sites@@@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}/token\")\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}/token\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:token/get","required":true}]}},"/hosting/web/{serviceName}/vcs/webhooks":{"get":{"summary":"Get VCS webhook URLs","description":"Returns the webhook URL to call on push events to deploy a website. Filter it by hosting path and VCS platform.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"path","description":"Filter on hosting path","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"query","name":"vcs","description":"Filter on VCS platform","required":true,"schema":{"$ref":"#/components/schemas/hosting.web.SupportedVcsEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.VcsWebhooks"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/vcs/webhooks\")\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}/vcs/webhooks\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:vcs/webhooks/get","required":true}]}},"/hosting/web/{serviceName}/website":{"get":{"summary":"List websites","description":"Returns the IDs of the websites of the hosting. Filter them by path.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"path","description":"Filter the value of path property","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/website\")\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}/website\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/get","required":true}],"x-expanded-response":"HostingWebWebsite"},"post":{"summary":"Create a website","description":"Creates a website in a folder of the hosting, deployed from a repository branch, and returns the task.","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.website.CreationRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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: hosting.web.website.CreationRequest\nresult = client.post(\"/hosting/web/{serviceName}/website\",\n\tpath = None, # Relative path on the hosting filesystem the website will be deployed into (type: string)\n\tvcsBranch = None, # Branch of the repository containing the website source code to deploy (type: string)\n\tvcsUrl = None, # Clone URL of the repository containing the website source code to deploy (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.website.CreationRequest\n$result = $ovh->post(\"/hosting/web/{serviceName}/website\", array(\n\tpath => null, // Relative path on the hosting filesystem the website will be deployed into (type: string)\n\tvcsBranch => null, // Branch of the repository containing the website source code to deploy (type: string)\n\tvcsUrl => null, // Clone URL of the repository containing the website source code to deploy (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/create","required":true}]}},"/hosting/web/{serviceName}/website/{id}":{"delete":{"summary":"Delete a website","description":"Deletes the website and returns the task. Set deleteFiles to true to also empty the website folder.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"deleteFiles","description":"Whether the website path should be emptied or not","required":true,"schema":{"type":"boolean"}},{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.delete(\"/hosting/web/{serviceName}/website/{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}/website/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/delete","required":true}]},"get":{"summary":"Get a website","description":"Returns the name, path, status, domains and repository of the website.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.Website"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/website/{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}/website/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/get","required":true}],"x-response-identifier":"id"},"put":{"summary":"Update a website","description":"Updates the repository branch deployed on the website.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.website.Update"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.Website"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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.website.Update\nresult = client.put(\"/hosting/web/{serviceName}/website/{id}\",\n\tvcsBranch = None, # Branch of the repository containing the website source code to deploy (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.website.Update\n$result = $ovh->put(\"/hosting/web/{serviceName}/website/{id}\", array(\n\tvcsBranch => null, // Branch of the repository containing the website source code to deploy (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/edit","required":true}]}},"/hosting/web/{serviceName}/website/{id}/deploy":{"post":{"summary":"Deploy a website","description":"Deploys the website from its repository branch and returns the task. Set reset to true to reset the website files before deploying.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.website.DeploymentRequest"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.PublicTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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: hosting.web.website.DeploymentRequest\nresult = client.post(\"/hosting/web/{serviceName}/website/{id}/deploy\",\n\treset = None, # Whether a reset was requested before deploying (type: boolean)\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.website.DeploymentRequest\n$result = $ovh->post(\"/hosting/web/{serviceName}/website/{id}/deploy\", array(\n\treset => null, // Whether a reset was requested before deploying (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/deploy","required":true}]}},"/hosting/web/{serviceName}/website/{id}/deployment":{"get":{"summary":"List deployments","description":"Returns the IDs of the deployments of the website.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@30"]],"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}/website/{id}/deployment\")\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}/website/{id}/deployment\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/deployment/get","required":true}],"x-expanded-response":"HostingWebWebsiteDeployment"}},"/hosting/web/{serviceName}/website/{id}/deployment/{deploymentId}":{"get":{"summary":"Get a deployment","description":"Returns the status, source, branch and last commit of the deployment.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"deploymentId","description":"Deployment ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.website.Deployment"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/website/{id}/deployment/{deploymentId}\")\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}/website/{id}/deployment/{deploymentId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/deployment/get","required":true}],"x-response-identifier":"id"}},"/hosting/web/{serviceName}/website/{id}/deployment/{deploymentId}/logs":{"get":{"summary":"Get deployment logs","description":"Returns the dated log messages of the deployment.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"deploymentId","description":"Deployment ID","required":true,"schema":{"type":"integer"}},{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.website.deployment.LogsMessage"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/website/{id}/deployment/{deploymentId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/web/{serviceName}/website/{id}/deployment/{deploymentId}/logs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:website/deployment/logs/get","required":true}]}},"/hosting/web/{serviceName}/websiteCreationCapabilities":{"get":{"summary":"Get website creation capabilities","description":"Returns the number of existing websites and the number allowed by the offer, then the same for the websites deployed from a Git repository, -1 meaning unlimited.","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.WebsiteCreationCapabilities"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","My sites@@@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}/websiteCreationCapabilities\")\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}/websiteCreationCapabilities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:websiteCreationCapabilities/get","required":true}]}}}}
