How to create and manage a web application using the OVHcloud public API (EN)

Objective

This guide explains how to use the OVHcloud public API to create and manage a web application on your hosting plan. You will learn how to perform key operations such as attaching domains, managing databases, and configuring SSL certificates.

Requirements

• An OVHcloud Web Hosting plan
• Basic knowledge of the REST API.
• Access to the OVHcloud API. Read our Getting started with OVHcloud APIs guide.

Instructions

Retrieving service information

The first step is to retrieve the serviceName, a unique ID for your web hosting service. You will need it for most of the following API calls.

This command returns a list of your web hosting services. Each entry in the list is a serviceName.

Return example :

[
  "example.cluster01.hosting.ovh.net",
  "example2.cluster02.hosting.ovh.net"
]

Attaching a domain

Attach a domain to your web hosting service:

Return example :

{
 "doneDate": "2024-08-22T08:13:50.740Z",
 "function": "abuse/close",
 "id": 0,
 "lastUpdate": "2024-08-22T08:13:50.740Z",
 "objectId": "string",
 "objectType": "Abuse",
 "startDate": "2024-08-22T08:13:50.740Z",
 "status": "cancelled"
}

Generating SSL certificates

Configure and manage SSL certificates to secure your website:

Return example :

{
 "isReportable": false,
 "provider": "COMODO",
 "regenerable": false,
 "status": "created",
 "taskId": 0,
 "type": "CUSTOM"
}

Managing databases

With the OVHcloud Web Hosting APIs, you can also manage your databases.

Creating a database

Return example :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listing existing databases

List all the databases associated with your web hosting service:

Return example :

[
 "example.mysql.db",
 "example2.mysql.db"
]

Managing modules

Retrieving a list of modules

Get a list of available modules that you can install on your web hosting plan:

Return example :

[
 195,
 184,
 38,
 176
]

Retrieving a module's information

Get the details of a specific module installed on your web hosting plan:

Return example :

{
 "keywords": [
   "gallery"
 ],
 "adminNameType": "string",
 "author": "OVH",
 "branch": "old",
 "id": 195,
 "size": {
   "value": 0,
   "unit": "B"
 },
 "name": "myname",
 "upgradeFrom": [],
 "language": [
   "en",
   "fr",
   "de",
   "es",
   "pl"
 ],
 "version": "1.4.2.2",
 "active": false,
 "languageRequirement": {
   "value": "php",
   "unit": "supported versions: ''\nnon supported versions: '8+'"
 },
 "latest": true
}

Installing a new module

Install a new module on your web hosting service:

Return example :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Managing FTP users

Manage FTP/SSH users on your Web Hosting plan to facilitate access and configuration.

Creating a new FTP/SSH user

Create a new FTP or SSH user to access your web hosting plan:

Return example :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listing FTP/SSH users

List all existing FTP/SSH users on your hosting service:

Return example :

[
 "user1",
 "user2",
 "user3",
 "user4"
]

Restoring a database

Create, list and restore database backups for your website.

Creating a backup of a database

Create a backup of your database to restore if necessary:

Return example :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Listing the available database backups

List all available backups for your databases:

Return example :

[
 1,
 12
]

Restoring a specific backup of a database

Restore a specific backup of your database if there is a problem:

Return example :

{
"doneDate": "2024-08-22T09:24:35.206Z",
"function": "string",
"id": 0,
"lastUpdate": "2024-08-22T09:24:35.206Z",
"objectId": "string",
"objectType": "Abuse",
"startDate": "2024-08-22T09:24:35.206Z",
"status": "cancelled"
}

Conclusion

This guide has introduced you to the main API requests for managing your OVHcloud web hosting plan, such as domain attachment, SSL certificate management and database management.

However, there are many other API calls available, which you can explore depending on your specific needs. For more options and features, you can refer to the « /hosting/web » section of the OVHcloud API.

Go further

Order a domain name via API

Join our community of users.