Skip to content

Extensions

All operations require authentication.

4 operationsv1/hosting/privateDatabase
Agent setup

List database extensionsProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension

Returns the names of the extensions available for the database.

Path parameters

databaseName
required
string

Database name

serviceName
required
string

Service name

Query parameters

extensionName
string

Filter results on extension name (like)

status
StatusEnum

Filter results on status (=)

Valuesdisableddisablingenabledenabling

Response

200string[]successful operation

Example uses databaseName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a database extensionProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName}

Returns the status and description of the extension, and the extensions it requires.

Path parameters

databaseName
required
string

Database name

extensionName
required
string

Extension name

serviceName
required
string

Service name

Response

200Extensionsuccessful operation
description
read-only
string

Extension details

extensionName
read-only
string

Extension name

requiredExtensions
read-only
string[]

Required extensions

status
read-only
StatusEnum

Extension status

Valuesdisableddisablingenabledenabling

Example uses databaseName = string, extensionName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "extensionName": "string", "requiredExtensions": [ "string" ], "status": "disabled"}

Disable an extensionProduction

POST
/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName}/disable

Disables the extension on the database. Returns a task to follow the change.

Path parameters

databaseName
required
string

Database name

extensionName
required
string

Extension name

serviceName
required
string

Service name

Response

200Tasksuccessful operation
databaseName
read-only
string

Database name on which the task is working

doneDate
read-only
stringdate-time

Completion date

dumpId
read-only
integer

DumpId on which the task is working

function
read-only
FunctionEnum

Function name

ValuesabusechangeFtpPasswordchangeRamchangeVersionconfiguration/updatecreatedatabase/copydatabase/copyRestoredatabase/createdatabase/deletedatabase/dumpdatabase/dump/deletedatabase/extension/createdatabase/extension/deletedatabase/importdatabase/restoredatabase/wizarddeletegrant/creategrant/deletegrant/updateinstalloverquota/inoverquota/outquotaRefreshrefreshreopenrestartstartstopsuspenduser/changePassworduser/createuser/deletewebhostingNetwork/disablewebhostingNetwork/enablewhitelist/createwhitelist/deletewhitelist/update
id
read-only
integer

The id of the task

lastUpdate
read-only
stringdate-time

Last update

startDate
read-only
stringdate-time

Task creation date

status
read-only
StatusEnum

Task status

Valuescancelleddoingdoneerrortodo
userName
read-only
string

User name on which the task is working

Example uses databaseName = string, extensionName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName}/disable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "databaseName": "string", "doneDate": "2024-01-01T12:00:00Z", "dumpId": 0, "function": "abuse", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "userName": "string"}

Enable an extensionProduction

POST
/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName}/enable

Enables the extension on the database. The extensions it requires are not enabled automatically: enable them first.

Path parameters

databaseName
required
string

Database name

extensionName
required
string

Extension name

serviceName
required
string

Service name

Response

200Tasksuccessful operation
databaseName
read-only
string

Database name on which the task is working

doneDate
read-only
stringdate-time

Completion date

dumpId
read-only
integer

DumpId on which the task is working

function
read-only
FunctionEnum

Function name

ValuesabusechangeFtpPasswordchangeRamchangeVersionconfiguration/updatecreatedatabase/copydatabase/copyRestoredatabase/createdatabase/deletedatabase/dumpdatabase/dump/deletedatabase/extension/createdatabase/extension/deletedatabase/importdatabase/restoredatabase/wizarddeletegrant/creategrant/deletegrant/updateinstalloverquota/inoverquota/outquotaRefreshrefreshreopenrestartstartstopsuspenduser/changePassworduser/createuser/deletewebhostingNetwork/disablewebhostingNetwork/enablewhitelist/createwhitelist/deletewhitelist/update
id
read-only
integer

The id of the task

lastUpdate
read-only
stringdate-time

Last update

startDate
read-only
stringdate-time

Task creation date

status
read-only
StatusEnum

Task status

Valuescancelleddoingdoneerrortodo
userName
read-only
string

User name on which the task is working

Example uses databaseName = string, extensionName = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/database/{databaseName}/extension/{extensionName}/enable \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "databaseName": "string", "doneDate": "2024-01-01T12:00:00Z", "dumpId": 0, "function": "abuse", "id": 0, "lastUpdate": "2024-01-01T12:00:00Z", "startDate": "2024-01-01T12:00:00Z", "status": "cancelled", "userName": "string"}