Skip to content

Grants

All operations require authentication.

5 operationsv1/hosting/privateDatabase
Agent setup

List user grantsProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant

Returns the names of the databases the user has a grant on.

Path parameters

serviceName
required
string

Service name

userName
required
string

User name

Response

200string[]successful operation

Example uses serviceName = string, userName = string

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

Create a user grantProduction

POST
/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant

Grants the user rights on a database. Returns a task to follow the change.

Path parameters

serviceName
required
string

Service name

userName
required
string

User name

Request body (required)

databaseName
required
string

Database name where add grant

grant
required
GrantEnum

Grant on a database for a specific user

Valuesadminnoneoverquota_adminoverquota_rwrorw

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 serviceName = string, userName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant \
  -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"}

Get a user grantProduction

GET
/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName}

Returns the rights of the user on the database and the creation date of the grant.

Path parameters

databaseName
required
string

Database name

serviceName
required
string

Service name

userName
required
string

User name

Response

200Grantsuccessful operation
creationDate
read-only
stringdate-time

Automatic deletion date of the dump

databaseName
read-only
string

Dump of this database name

grant
read-only
GrantEnum

Grant set

Valuesadminnoneoverquota_adminoverquota_rwrorw

Example uses databaseName = string, serviceName = string, userName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "creationDate": "2024-01-01T12:00:00Z", "databaseName": "string", "grant": "admin"}

Delete a user grantProduction

DELETE
/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName}

Revokes the rights of the user on the database. The user and the database are kept.

Path parameters

databaseName
required
string

Database name

serviceName
required
string

Service name

userName
required
string

User 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, serviceName = string, userName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName} \
  -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"}

Update a user grantProduction

POST
/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName}/update

Changes the rights of the user on the database. Returns a task to follow the change.

Path parameters

databaseName
required
string

Database name

serviceName
required
string

Service name

userName
required
string

User name

Request body (required)

grant
required
GrantEnum

Grant on a database for a specific user

Valuesadminnoneoverquota_adminoverquota_rwrorw

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, serviceName = string, userName = string

$ curl https://api.eu.ovhcloud.com/1.0/hosting/privateDatabase/{serviceName}/user/{userName}/grant/{databaseName}/update \
  -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"}