Web Hosting
All operations require authentication, except the one marked Public.
List web hostingsProduction
Returns the service names of the web hostings of the account.
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
List boost historyProduction
Returns the dates of the boost changes of the hosting. Filter them by date.
Path parameters
Service name
Query parameters
Filter the value of date property (=)
Response
Example uses serviceName = string
$ curl https:/[ "2024-01-01T12:00:00Z"]
List web hostingsBeta
Returns the web hostings of the account.
Query parameters
Filter resources on IAM tags
Headers
Pagination cursor
Pagination size
Response
Computed hash used to control concurrent modification requests. Here, it represents the current target specification value.
Current state of the hosting plan
Ongoing asynchronous tasks related to the hosting plan
IAM resource metadata
Unique identifier of the resource. Here, the service name is used as an identifier.
Webhosting resource readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGReads your token from $OVH_TOKEN
$ curl https:/[ { "checksum": "string", "currentState": { "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING" }]
Get a web hostingProduction
Returns the offer, state, cluster, recommended IPs, disk and traffic quotas, and PHP versions of the web hosting.
Path parameters
Service name
Response
Available offers for boost option
Current boost offer
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupCluster name
This direct ip to your cluster ( usefull for application like api )
This direct ipv6 to your cluster ( usefull for application like api )
Available clusterIp by countries
Datacenter where this account is located
The default attached domain created along with your hosting
Set the name displayed in ManagerV6 for your hosting (max 50 chars)
Filer name
Has a CDN service linked on the hosting
Has a HostedSSL service linked on the hosting
Path of your home
The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )
The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )
IAM resource metadata
/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data
If set to true, service can manage more than only one certificate
objects allowed
objects used
Hosting offer
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupHosting's OS
linuxState of available php versions for this account
Hosting's main login
Space allowed
Space used
If your offer is old, return a recommended offer to migrate on
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupHosting resource type
bestEffortclouddedicatedsharedURLs to use to manage your webhosting
Service name
State of your hosting
activeblockedbloquedhardBlockedhardBloquedmaintenanceUse to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )
Traffic quota allowed ( null = unlimited )
Traffic quota used
List of updates on your hosting
Example uses serviceName = string
$ curl https:/{ "availableBoostOffer": [ { "offer": "CLOUDWEB_1", "price": { "currencyCode": "AUD", "priceInUcents": 0, "text": "string", "value": 0 } } ], "boostOffer": "CLOUDWEB_1", "cluster": "string", "clusterIp": "192.0.2.0", "clusterIpv6": "2001:41d0:1:1994::1", "countriesIp": [ { "country": "BE", "ip": "192.0.2.0", "ipv6": "2001:41d0:1:1994::1" } ], "datacenter": "string", "defaultAttachedDomain": "string", "displayName": "string", "filer": "string", "hasCdn": true, "hasHostedSsl": true, "home": "string", "hostingIp": "192.0.2.0", "hostingIpv6": "2001:41d0:1:1994::1", "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "lastOvhConfigScan": "2024-01-01T12:00:00Z", "multipleSSL": true, "objectQuota": 0, "objectUsed": 0, "offer": "CLOUDWEB_1", "operatingSystem": "linux", "phpVersions": [ { "support": "BETA", "version": "string" } ], "primaryLogin": "string", "quotaSize": { "unit": "string", "value": 0 }, "quotaUsed": { "unit": "string", "value": 0 }, "recommendedOffer": "CLOUDWEB_1", "resourceType": "bestEffort", "serviceManagementAccess": { "ftp": { "port": 0, "url": "string" }, "http": { "port": 0, "url": "string" }, "ssh": { "port": 0, "url": "string" } }, "serviceName": "string", "state": "active", "token": "string", "trafficQuotaSize": { "unit": "string", "value": 0 }, "trafficQuotaUsed": { "unit": "string", "value": 0 }, "updates": [ "string" ]}
List available offersProduction
List available offers. Returns the offers that can be ordered for the given domain, to create a new hosting or upgrade an existing one.
Query parameters
Domain you want to add or upgrade a hosting
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "CLOUDWEB_1"]
List current incidentsProduction
List current incidents. Returns the incidents in progress on the web hosting platform that can affect the hosting services.
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
Get offer capabilitiesProductionPublic
Get offer capabilities. Returns what an offer includes: attached domains, databases, disk, traffic, SSH, cron, modules and runtimes.
Query parameters
Describe offer capabilities
1000gp20gp240gp240pack240plan300gp60gp720pack720plan90pack90planCLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARTbusinesscloudweb1cloudweb2cloudweb3cloudwebbetax1depro2012deprol2012deproxl2012deproxxl2012destart2012destartl2012destartxl2012domainpackhosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startuphostingAtScaleX128hostingAtScaleX16hostingAtScaleX20hostingAtScaleX24hostingAtScaleX32hostingAtScaleX64hostingAtScaleX8itbusiness2012itperso2012itpremium2012kimsufi2015mailpackmailplanmediapackmediaplanovhpro1Toovhpro2Toovhpro5Topaas2014betaperf2014x1perf2014x2perf2014x3perf2014x4perso2010perso2014powerBeta1powerbeta1premiumpro2010pro2014start10gstart10mstart1gstart1gesstart1mstart5gstarterxxlpackxxlplanResponse
Number of domains you can attach to your hosting
Does the offer allow crontab
Number of database engines allowed for your hosting
Describe all databases type you can have
Disk capacity and type available for your hosting ( null for unlimited )
Describe all email offer you can have
Number of environment variables allowed for your hosting
Number of ftp user you can create
Does the offer allow access to web files browser?
Marketing information about the current offer
best-sellernewLanguage available for cron script
Does the offer allow 1-click modules?
Describe all privateDatabases type you can have
Number of runtimes allowed for your hosting
Number of sites recommended for your hosting ( -1 for unlimited )
Does the offer allow SSH access
Traffic quota size for your hosting ( null for unlimited )
Public: no token needed
$ curl https:/{ "attachedDomains": 0, "crontab": true, "databaseEngines": 0, "databases": [ { "available": 0, "engines": [ "mariadb" ], "isolation": "dedicated", "quota": { "unit": "string", "value": 0 }, "type": "extraSqlPerso" } ], "disk": { "type": "HDD", "unit": "string", "value": 0 }, "emails": { "available": 0, "quota": { "unit": "string", "value": 0 } }, "envVars": 0, "extraUsers": 0, "filesBrowser": true, "highlight": "best-seller", "languages": { "nodejs": [ "nodejs-10" ], "php": [ "phpfpm-5.6" ], "python": [ "python-2" ], "ruby": [ "ruby-2.6" ] }, "moduleOneClick": true, "privateDatabases": [ { "available": 0, "engines": [ "mariadb" ], "isolation": "dedicated", "quota": { "unit": "string", "value": 0 }, "type": "extraSqlPerso" } ], "runtimes": 0, "sitesRecommended": 0, "ssh": true, "traffic": { "unit": "string", "value": 0 }}
Get the abuse stateProduction
Returns the access, web, outgoing email and outgoing TCP states of the hosting.
Path parameters
Service name
Response
access state
activeblockedhardBlockedhardMaintenancemaintenancemailsout state
bouncekookspamspamLegalBlockedTCP out state
activeblockedhardBlockedweb state
activeblockedbloquedhardBlockedhardBloquedmaintenanceExample uses serviceName = string
$ curl https:/{ "accessState": "active", "mailsoutState": "bounce", "outState": "active", "webState": "active"}
List available configurationsProduction
List available configurations. Returns the language versions available for the application configuration. Filter them by language.
Path parameters
The internal name of your hosting
Query parameters
Filter on language name
nodejspythonrubyResponse
Example uses serviceName = string
$ curl https:/[ "nodejs-12"]
Get a boost history entryProduction
Returns the boost offer, the hosting offer at that time, the requesting account and the request date.
Path parameters
Date
Service name
Response
Account who requested the change
Boost offer used
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupThe date when the change has been requested
Offer when the change was made
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupExample uses date = 2024-01-01T12:00:00Z, serviceName = string
$ curl https:/{ "accountId": "string", "boostOffer": "CLOUDWEB_1", "date": "2024-01-01T12:00:00Z", "offer": "CLOUDWEB_1"}
Get the CDNProduction
Returns the domain, type, version and status of the CDN option, and whether it is free with the hosting.
Path parameters
Service name
Response
Domain of this CDN
Whether CDN is free with the hosting
Status of the CDN option
createdcreatingdeletingflushingreopeningsuspendedsuspendingThe task ID working on this CDN
Type of the CDN
Version of the CDN
Example uses serviceName = string
$ curl https:/{ "domain": "string", "free": true, "status": "created", "taskId": 0, "type": "string", "version": "string"}
Get CDN service informationProduction
Get CDN service information. Returns the billing information of the CDN option: creation and expiration dates, renewal settings and contacts.
Path parameters
The internal name of your hosting
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses serviceName = string
$ curl https:/{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
Get the configurationProduction
Get the configuration. Returns the language, version, environment, launch script and public directory of the application.
Path parameters
The internal name of your hosting
Response
Application environment
developmentproductionApplication launch script
Id of the current configuration
language chosen for the current hosting
nodejspythonrubyDirectory of the application
Status of current configuration
createdcreatingdeletingupdatingversion of the language chosen for the current hosting
Example uses serviceName = string
$ curl https:/{ "appEnv": "development", "entryPoint": "string", "id": 0, "language": "nodejs", "publicDir": "string", "status": "created", "version": "string"}
Get the email stateProduction
Get the email state. Returns the state of the emails sent by the hosting scripts, with the volumes sent, the bounces and the daily limit.
Path parameters
The internal name of your hosting
Response
Bounce
Email used to receive errors
Max email to sent per day
Email sent since hosting creation
Email sent today
Spoofing Bounce
Email state
bounceforcekookpurgingspamExample uses serviceName = string
$ curl https:/{ "bounce": 0, "email": "string", "maxPerDay": 0, "sent": 0, "sentToday": 0, "spoofing": 0, "state": "bounce"}
List email bouncesProduction
List email bounces. Returns the last bounces of the emails sent by the hosting: 20 by default, 100 at most with limit.
Path parameters
The internal name of your hosting
Query parameters
Maximum bounces limit ( default : 20 / max : 100 )
Response
The datetime of this bounce
Whether this bounce is spoofing or not
The return message for this bounce
The email where you have the bounce
Example uses serviceName = string
$ curl https:/[ { "date": "2024-01-01T12:00:00Z", "isSpoofing": true, "message": "string", "to": "string" }]
Get email volume historyProduction
Get email volume history. Returns the number of emails sent by the hosting scripts over time, as a list of dated volume points.
Path parameters
The internal name of your hosting
Response
The datetime of this volume history point
The volume history size
Example uses serviceName = string
$ curl https:/[ { "date": "2024-01-01T12:00:00Z", "volume": 0 }]
List email optionsProduction
List email options. Returns the IDs of the email options of the hosting. Each option is a mail service linked to the hosting.
Path parameters
The internal name of your hosting
Response
Example uses serviceName = string
$ curl https:/[ 0]
Get an email optionProduction
Get an email option. Returns the domain and creation date of the email option. Its billing information is returned by serviceInfos.
Path parameters
Id of the object
The internal name of your hosting
Response
Creation date
Email service domain
Account id
Example uses id = 0, serviceName = string
$ curl https:/{ "creationDate": "2024-01-01T12:00:00Z", "domain": "string", "id": 0}
Get email option service informationProduction
Get email option service information. Returns the billing information of the email option: creation and expiration dates, renewal settings and contacts.
Path parameters
Id of the object
The internal name of your hosting
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses id = 0, serviceName = string
$ curl https:/{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
List free domainsProduction
Returns the free domain names included with the hosting offer. Filter them by status.
Path parameters
Service name
Query parameters
Filter the freedom status (=)
blockedByCustomerblockedBySystemokpresetResponse
Example uses serviceName = string
$ curl https:/[ "string"]
Get a metrics tokenProduction
Returns a token to read the hosting metrics, the endpoint to query and the token expiration date.
Path parameters
Service name
Response
Backend url
Token expiration date
Generated token
Example uses serviceName = string
$ curl https:/{ "endpoint": "string", "expiry": "2024-01-01T12:00:00Z", "token": "string"}
List .ovhconfig filesProduction
List .ovhconfig files. Returns the IDs of the .ovhconfig configurations of the hosting. Filter them by path, or by historical to include old ones.
Path parameters
The internal name of your hosting
Query parameters
Filter the value of historical property (=)
Filter the value of path property (like)
Response
Example uses serviceName = string
$ curl https:/[ 0]
Get a .ovhconfig fileProduction
Get a .ovhconfig file. Returns the engine, version, container, environment, HTTP firewall and status of the configuration of a folder.
Path parameters
Configuration's id
The internal name of your hosting
Response
Container to run this website
When ovhconfig was created, or found for the first time, on the hosting servers
Version of engine you want
phpphpcgiName of engine you want
4.45.05.15.25.35.45.55.67.07.17.27.37.48.08.18.28.38.48.5AUTOEnvironment configuration you want
developmentproductionIf .ovhConfig exists
If this configuration is an old configuration
Configuration you want for http firewall
nonesecurityConfiguration's id
Config path, relative to your home directory
The configuration status
createdrollbackingupdatingThe task ID working on this configuration
Example uses id = 0, serviceName = string
$ curl https:/{ "container": "string", "creationDate": "2024-01-01T12:00:00Z", "engineName": "php", "engineVersion": "4.4", "environment": "development", "fileExist": true, "historical": true, "httpFirewall": "none", "id": 0, "path": "string", "status": "created", "taskId": 0}
List .ovhconfig capabilitiesProduction
List .ovhconfig capabilities. Returns the PHP versions and container images available on the hosting.
Path parameters
The internal name of your hosting
Response
Container image available
PHP version
5.45.55.67.07.17.27.37.48.08.18.28.38.48.5Example uses serviceName = string
$ curl https:/[ { "containerImage": [ "string" ], "version": "5.4" }]
Get recommended .ovhconfig valuesProduction
Get recommended .ovhconfig values. Returns the recommended engine, version, container, environment and HTTP firewall for the .ovhconfig file.
Path parameters
The internal name of your hosting
Response
Container to run this website
jessie.i386legacystablestable64testingEngine name
phpphpcgiPHP version
5.45.55.67.07.17.27.37.48.08.18.28.38.48.5Environment configuration
developmentproductionConfiguration for http firewall
nonesecurityExample uses serviceName = string
$ curl https:/{ "container": "jessie.i386", "engineName": "php", "engineVersion": "5.4", "environment": "development", "httpFirewall": "none"}
List runtime configurationsProduction
List runtime configurations. Returns the IDs of the runtime configurations of the hosting. Filter them by name or type.
Path parameters
The internal name of your hosting
Query parameters
Filter the value of name property (like)
Filter the value of type property (=)
nodejs-10nodejs-11nodejs-12nodejs-14nodejs-8nodejs-9phpfpm-5.6phpfpm-7.0phpfpm-7.1phpfpm-7.2phpfpm-7.3phpfpm-7.4phpfpm-8.0python-2python-3ruby-2.6Response
Example uses serviceName = string
$ curl https:/[ 0]
Get a runtime configurationProduction
Get a runtime configuration. Returns the backend type, environment, bootstrap script, public directory and status of the runtime configuration.
Path parameters
The runtime configuration ID
The internal name of your hosting
Response
The client application bootstrap script
The client application environment
developmentproductionThe creation date of the runtime configuration
The runtime configuration ID
Is the runtime configuration is the one by default for the hosting
Return if the runtime configuration can be deleted
The last update date of the runtime configuration
The custom display name of the runtime configuration
The client application public directory
The status of the runtime
createdcreatingdeletingupdatingThe link current task for the runtime configuration
The backend type of the runtime
nodejs-10nodejs-11nodejs-12nodejs-14nodejs-8nodejs-9phpfpm-5.6phpfpm-7.0phpfpm-7.1phpfpm-7.2phpfpm-7.3phpfpm-7.4phpfpm-8.0python-2python-3ruby-2.6Example uses id = 0, serviceName = string
$ curl https:/{ "appBootstrap": "string", "appEnv": "development", "creationDate": "2024-01-01T12:00:00Z", "id": 0, "isDefault": true, "isDeletable": true, "lastUpdate": "2024-01-01T12:00:00Z", "name": "string", "publicDir": "string", "status": "created", "taskId": 0, "type": "nodejs-10"}
List runtime configuration domainsProduction
List runtime configuration domains. Returns the attached domains that use the runtime configuration. Link a domain to it with its runtimeId.
Path parameters
The runtime configuration ID
The internal name of your hosting
Response
Example uses id = 0, serviceName = string
$ curl https:/[ "string"]
List runtime backend typesProduction
List runtime backend types. Returns the backend types available for runtime configurations. Filter them by programming language.
Path parameters
The internal name of your hosting
Query parameters
Specific programming language to filter
Response
Example uses serviceName = string
$ curl https:/[ "nodejs-10"]
Get service informationProduction
Returns the billing information of the service: creation and expiration dates, renewal settings and contacts.
Path parameters
Service name
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses serviceName = string
$ curl https:/{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
Get a web hostingBeta
Returns the web hosting, identified by its service name, with its current state and running tasks.
Path parameters
Name
Response
Computed hash used to control concurrent modification requests. Here, it represents the current target specification value.
Current state of the hosting plan
Ongoing asynchronous tasks related to the hosting plan
IAM resource metadata
Unique identifier of the resource. Here, the service name is used as an identifier.
Webhosting resource readiness in the system
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGExample uses name = string
$ curl https:/{ "checksum": "string", "currentState": { "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "id": "string", "resourceStatus": "CREATING"}
Update CDN renewalProduction
Update CDN renewal. Updates the renewal settings of the CDN option: automatic renewal, renewal period and deletion at expiration.
Path parameters
The internal name of your hosting
Request body (required)
Renew type
Response
Example uses serviceName = string
$ curl https:/Terminate the CDN optionProduction
Terminate the CDN option. Requests the termination of the CDN option. A link to confirm it is sent by email to the administrator contact.
Path parameters
The internal name of your hosting
Response
Example uses serviceName = string
$ curl https:/"string"
Change contactsProduction
Starts the contact change procedure of the service. Returns the identifiers of the created tasks.
Path parameters
Service name
Request body (required)
The contact to set as admin contact
The contact to set as billing contact
The contact to set as tech contact
Response
Example uses serviceName = string
$ curl https:/[ 0]
Confirm terminationProduction
Confirms the termination of the service with the token sent by email.
Path parameters
Service name
Request body (required)
Commentary about your termination request
Commentary about your future use
Commentary about your reason for termination request
All future uses you can provide for a service termination
NOT_REPLACING_SERVICEOTHERSUBSCRIBE_AN_OTHER_SERVICESUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITORSUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITORAll reasons you can provide for a service termination
FEATURES_DONT_SUIT_MELACK_OF_PERFORMANCESMIGRATED_TO_ANOTHER_OVH_PRODUCTMIGRATED_TO_COMPETITORNOT_ENOUGH_RECOGNITIONNOT_NEEDED_ANYMORENOT_RELIABLENO_ANSWEROTHERPRODUCT_DIMENSION_DONT_SUIT_MEPRODUCT_TOOLS_DONT_SUIT_METOO_EXPENSIVETOO_HARD_TO_USEUNSATIFIED_BY_CUSTOMER_SUPPORTThe termination token sent by email to the admin contact
Response
Example uses serviceName = string
$ curl https:/"string"
Run an email actionProduction
Run an email action. Blocks or unblocks the emails sent by the hosting scripts, or purges the queue of emails waiting to be sent.
Path parameters
The internal name of your hosting
Request body (required)
Action you want to request
BLOCKPURGEUNBLOCKResponse
Example uses serviceName = string
$ curl https:/"string"
Terminate an email optionProduction
Terminate an email option. Requests the termination of the email option. A link to confirm it is sent by email to the administrator contact.
Path parameters
Id of the object
The internal name of your hosting
Response
Example uses id = 0, serviceName = string
$ curl https:/"string"
Change a .ovhconfig fileProduction
Change a .ovhconfig file. Applies a new engine, version, container, environment or HTTP firewall setting to the folder, and returns the task.
Path parameters
Configuration's id
The internal name of your hosting
Request body (required)
Container to run this website
jessie.i386legacystablestable64testingVersion of engine you want
phpphpcgiName of engine you want
5.45.55.67.07.17.27.37.48.08.18.28.38.48.5Environment configuration you want
developmentproductionConfiguration you want for http firewall
nonesecurityResponse
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses id = 0, serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Roll back a .ovhconfig fileProduction
Roll back a .ovhconfig file. Restores the old configuration given by rollbackId and returns the task.
Path parameters
Configuration's id
The internal name of your hosting
Request body (required)
The configuration's id you want to rollback
Response
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses id = 0, serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Refresh .ovhconfig filesProduction
Refresh .ovhconfig files. Synchronizes the list of configurations with the .ovhconfig files on the hosting, and returns the task.
Path parameters
The internal name of your hosting
Response
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Run an actionProduction
Run an action. Checks the quota, flushes the cache or runs an antihack scan on the hosting, and returns the task.
Path parameters
The internal name of your hosting
Request body (required)
Action you want to request
CHECK_QUOTAFLUSH_CACHESCAN_ANTIHACKResponse
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Request a boostProduction
Applies the requested boost offer to the hosting and returns the task. Send a null offer to disable the boost.
Path parameters
Service name
Request body (required)
Requested boost offer
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupResponse
Done date
Task function
abuse/closeabuse/createabuse/create/webabuse/delete/webabuse/updateabuse/update/webagora/AnycastUpdateReferenceagora/DnsAddonUpdateReferenceagora/DnsUpdateReferenceagora/updateReferenceattachedDomain/createattachedDomain/deleteattachedDomain/restartattachedDomain/updatecdn/deletecdn/domain/createcdn/domain/deletecdn/domain/flushcdn/domain/suspendcdn/flushcdn/installcdn/reopencdn/suspendcdn/upgradecluster/setDevelopmentcluster/setTestingcluster/ssl/deploycluster/ssl/renewcluster/test/attachedDomainscluster/test/cdncluster/test/cronscluster/test/emailscluster/test/fileBrowsercluster/test/hostedsslcluster/test/modulescluster/test/ovhConfigcluster/test/userLogscluster/test/usersconfiguration/createconfiguration/deleteconfiguration/updatecron/createcron/deletecron/updatedatabase/changePassworddatabase/changePasswordTestdatabase/changeRightdatabase/changeRightTestdatabase/checkQuotaNowdatabase/copydatabase/copyRestoredatabase/createdatabase/deletedatabase/deleteTestdatabase/dumpAnyDaydatabase/hostUpdatedatabase/importdatabase/optimizedatabase/restorededicatedIp/deletededicatedIp/reopendedicatedIp/suspenddepc/pushdump/createdump/deleteenvVar/createenvVar/deleteenvVar/updateenvVar/upgradeeventbus/pushfilerz/customerMonitoringfilerz/deletehostedssl/assignFreeKeyhostedssl/cdn/updatehostedssl/createhostedssl/deletehostedssl/globalsign/deletehostedssl/htaccess/installhostedssl/importhostedssl/installhostedssl/install/sectigohostedssl/iplb/reloadhostedssl/pushhostedssl/pushDcvFilehostedssl/regeneratehostedssl/repushhosting/activate/privateDatabasehosting/basculementhosting/changeOffer/cloudhosting/changeOffer/sharedhosting/changementhosting/deletehosting/delete_start1mhosting/installhosting/reopenhosting/suspendindy/reopenindy/suspendinfra/certificate/deployinfra/certificate/generateinfra/certificate/installinfra/sharedsql/upgradeinfra/ssl/deployinfra/ssl/renewip/moveip/parklocalSeoAccount/createlocalSeoAccount/deletelocalSeoLocation/deletelocalSeoLocation/installlocalSeoLocation/reopenlocalSeoLocation/suspendlocalSeoVisibilityCheck/processmailsout/checkMailsoutQueuemailsout/flushMailsoutQueuemailsout/updateUserInRedismigration/copyUsersmigration/dday/filerzmigration/dday/listPrivateDatabasesmigration/dday/lotmigration/dday/updateInfra/cronsmigration/dday/updateInfra/dedicatedmigration/dday/updateInfra/migratedFqdnmigration/updateOrtmodule/changePasswordmodule/createmodule/deletemodule/installmonitoring/remotewritenotification/sendovhConfig/refreshovhConfig/rollbackovhConfig/updateovhOrg/deleteownLogs/createownLogs/deleteprovisionning/cdnprovisionning/clusterprovisionning/filerzprovisionning/filerz_logprovisionning/hostingprovisionning/ipfoprovisionning/ipifoprovisionning/iplbprovisionning/privatesqlprovisionning/sharedsqlprovisionning/sslprovisionning/webprovisionning/webappruntime/createruntime/deleteruntime/setDefaultruntime/updatescan/createsqlperso/deletesqlperso/installsqlperso/reopensqlperso/suspendsynchronizeDepc/attachedDomainsynchronizeDepc/clustersynchronizeDepc/databasesynchronizeDepc/filersynchronizeDepc/offersynchronizeDepc/webdtest/migrationuser/changePassworduser/createuser/deleteuser/updateuserLogs/changePassworduserLogs/createuserLogs/deleteuster/setTestingweb/changeDnsweb/changeFilerzweb/changeFilerzWithCallbackweb/changeJailStateweb/changeOutStateweb/changeStateweb/changeWebStateweb/checkQuotaNowweb/createweb/deleteweb/deleteUserweb/restoreSnapshotwebProvisionningwebd/changeSlotswebsite/createwebsite/deletewebsite/deploywebsite/vcs/createwebsite/vcs/deletewebsite/vcs/deployTask's id
Last update date
Task object id
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdStart date
Task status
cancelleddoingdoneerrorinittodoExample uses serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "abuse/close", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Restore a backupProduction
Restore a backup. Restores the files of the hosting from a daily or weekly backup and returns the task. All current files are replaced by the backup. Databases are not restored.
Path parameters
The internal name of your hosting
Request body (required)
The backup you want to restore
daily.1daily.2daily.3weekly.1weekly.2Response
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Create a runtime configurationProduction
Create a runtime configuration. Creates a runtime configuration with a backend type, an environment, a bootstrap script and a public directory, linked to attached domains, and returns the task.
Path parameters
The internal name of your hosting
Request body (required)
The client application bootstrap script
The client application environment
developmentproductionThe attached domains fqdn to link to this runtime configuration
Set if the runtime configuration is the one by default for the hosting
The custom display name of the runtime configuration
The client application public directory
The backend type of a runtime configuration
nodejs-10nodejs-11nodejs-12nodejs-14nodejs-8nodejs-9phpfpm-5.6phpfpm-7.0phpfpm-7.1phpfpm-7.2phpfpm-7.3phpfpm-7.4phpfpm-8.0python-2python-3ruby-2.6Response
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Request terminationProduction
Requests the termination of the service. Confirm it with confirmTermination and the token sent by email.
Path parameters
Service name
Response
Example uses serviceName = string
$ curl https:/"string"
Unblock outgoing TCPProduction
Requests the unblocking of the outgoing TCP connections of the hosting, blocked after an abuse. Their current state is outState in the abuse state.
Path parameters
Service name
Response
Example uses serviceName = string
$ curl https:/Delete a runtime configurationProduction
Delete a runtime configuration. Deletes the runtime configuration and returns the task. Only a configuration with isDeletable set to true can be deleted.
Path parameters
The runtime configuration ID
The internal name of your hosting
Response
Completion date
Function name
the id of the task
last update
Task related object ID
Task object type
AbuseAttachedDomainBlockedIpCdnCronDatabaseDumpEnvVarFilerzHostedsslHostingIndyInfraMinorModuleOtherOvhConfigOvhOrgOwnLogsRuntimeScanSqlpersoUserUserLogsWebWebdTask Creation date
Task status
cancelleddoingdoneerrorinittodoExample uses id = 0, serviceName = string
$ curl https:/{ "doneDate": "2024-01-01T12:00:00Z", "function": "string", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "objectId": "string", "objectType": "Abuse", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled"}
Update a web hostingProduction
Updates the display name of the web hosting.
Path parameters
Service name
Request body (required)
Available offers for boost option
Current boost offer
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupCluster name
This direct ip to your cluster ( usefull for application like api )
This direct ipv6 to your cluster ( usefull for application like api )
Available clusterIp by countries
Datacenter where this account is located
The default attached domain created along with your hosting
Set the name displayed in ManagerV6 for your hosting (max 50 chars)
Filer name
Has a CDN service linked on the hosting
Has a HostedSSL service linked on the hosting
Path of your home
The recommended ip for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )
The recommended ipv6 for your hosting ( depends on hosting's linked services, e.g CDN or hostedSSL )
/hosting/web/{serviceName}/ovhConfig is stored in cache. This date is the last refresh of this data
If set to true, service can manage more than only one certificate
objects allowed
objects used
Hosting offer
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupHosting's OS
linuxState of available php versions for this account
Hosting's main login
Space allowed
Space used
If your offer is old, return a recommended offer to migrate on
CLOUDWEB_1CLOUDWEB_2CLOUDWEB_3KSPERFORMANCE_1PERFORMANCE_2PERFORMANCE_3PERFORMANCE_4PERSOPOWER_BETA_1PROSTARThosting-agencyhosting-agency-maxhosting-agency-plushosting-free-100mhosting-performance-1hosting-performance-2hosting-performance-3hosting-performance-4hosting-persohosting-prohosting-starterhosting-starter-ovhhosting-startupHosting resource type
bestEffortclouddedicatedsharedURLs to use to manage your webhosting
Service name
State of your hosting
activeblockedbloquedhardBlockedhardBloquedmaintenanceUse to link an external domain. ( This token has to be insert into a TXT field on your dns zone with ovhcontrol subdomain )
Traffic quota allowed ( null = unlimited )
Traffic quota used
List of updates on your hosting
Response
Example uses serviceName = string
$ curl https:/Update the configurationProduction
Update the configuration. Updates the language, version, environment, launch script or public directory of the application.
Path parameters
The internal name of your hosting
Request body (required)
Application environment
developmentproductionApplication launch script
Id of the current configuration
language chosen for the current hosting
nodejspythonrubyDirectory of the application
Status of current configuration
createdcreatingdeletingupdatingversion of the language chosen for the current hosting
Response
Example uses serviceName = string
$ curl https:/Update the email settingsProduction
Update the email settings. Updates the email address that receives the sending errors of the hosting scripts. The other fields are read-only.
Path parameters
The internal name of your hosting
Request body (required)
Bounce
Email used to receive errors
Max email to sent per day
Email sent since hosting creation
Email sent today
Spoofing Bounce
Email state
bounceforcekookpurgingspamResponse
Example uses serviceName = string
$ curl https:/Update a runtime configurationProduction
Update a runtime configuration. Updates the name, backend type, environment, bootstrap script, public directory or default status of the runtime configuration.
Path parameters
The runtime configuration ID
The internal name of your hosting
Request body (required)
The client application bootstrap script
The client application environment
developmentproductionThe creation date of the runtime configuration
The runtime configuration ID
Is the runtime configuration is the one by default for the hosting
Return if the runtime configuration can be deleted
The last update date of the runtime configuration
The custom display name of the runtime configuration
The client application public directory
The status of the runtime
createdcreatingdeletingupdatingThe link current task for the runtime configuration
The backend type of the runtime
nodejs-10nodejs-11nodejs-12nodejs-14nodejs-8nodejs-9phpfpm-5.6phpfpm-7.0phpfpm-7.1phpfpm-7.2phpfpm-7.3phpfpm-7.4phpfpm-8.0python-2python-3ruby-2.6Response
Example uses id = 0, serviceName = string
$ curl https:/Update service informationProduction
Updates the renewal settings of the service.
Path parameters
Service name
Request body (required)
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidResponse
Example uses serviceName = string
$ curl https:/