Skip to content
Console(the OVHcloud Console, opens in a new tab)

Roles

All operations require authentication.

18 operationsv1/dbaas/logs
OpenAPI
Agent setup

List rolesDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the roles of the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

Query parameters

namePattern
string

Filter by name (like)

Response

200string[]successful operation
403objectError 403 response
404objectError 404 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "00000000-0000-0000-0000-000000000000"]

List role membersDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role/{roleId}/member

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the role members of the Logs Data Platform service.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200string[]successful operation
403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/member \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "string"]

List role permissionsDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the role permissions of the Logs Data Platform service.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200string[]successful operation
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "00000000-0000-0000-0000-000000000000"]

Get a roleDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role/{roleId}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200Rolesuccessful operation
createdAt
read-only
stringdate-time

Role creation

description
read-only
string

Role description

name
read-only
string

Role name

nbMember
read-only
integer

Number of members

nbPermission
read-only
integer

Number of permissions

roleId
read-only
stringuuid

Role ID

updatedAt
read-only
stringdate-time

Role last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "description": "string",  "name": "string",  "nbMember": 0,  "nbPermission": 0,  "roleId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Get a role memberDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the role member.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

username
required
string

Username

Response

200Membersuccessful operation
createdAt
read-only
stringdate-time

Membership creation

note
read-only
string

Custom note

username
read-only
string

Username on DBaaS Logs

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string, username = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "note": "string",  "username": "string"}

Get a role permissionDeprecated

GET
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/{permissionId}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Returns the role permission.

Path parameters

permissionId
required
stringuuid

Permission ID

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200Permissionsuccessful operation
aliasId
read-only
stringuuid

Associated Elasticsearch alias

dashboardId
read-only
stringuuid

Associated Graylog dashboard

indexId
read-only
stringuuid

Associated Elasticsearch index

osdId
read-only
stringuuid

Associated OpenSearch Dashboards instance

permissionId
read-only
stringuuid

Permission ID

permissionType
read-only
PermissionTypeEnum

Permission type

ValuesREAD_ONLYREAD_WRITE
streamId
read-only
stringuuid

Associated Graylog stream

404objectError 404 response

Example uses permissionId = 00000000-0000-0000-0000-000000000000, roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/{permissionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "permissionId": "00000000-0000-0000-0000-000000000000",  "permissionType": "READ_ONLY",  "streamId": "00000000-0000-0000-0000-000000000000"}

Create a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Creates a role on the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

Request body (required)

description
required
string

Description

name
required
string

Name

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add a role memberDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/member

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Adds a member to the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

note
string

Custom note

username
required
string

Username

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/member \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add an alias permission to a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/alias

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Grants the role permission on an alias.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

aliasId
required
stringuuid

Alias ID

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/alias \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add a dashboard permission to a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/dashboard

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Grants the role permission on a dashboard.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

dashboardId
required
stringuuid

Dashboard ID

permissionType
PermissionTypeEnum

Permission type

ValuesREAD_ONLYREAD_WRITE

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/dashboard \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add an index permission to a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/index

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Grants the role permission on an index.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

indexId
required
stringuuid

Index ID

permissionType
PermissionTypeEnum

Permission type

ValuesREAD_ONLYREAD_WRITE

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/index \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add an OpenSearch Dashboards permission to a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/osd

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Grants the role permission on an OpenSearch Dashboards instance.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

osdId
required
stringuuid

Osd ID

permissionType
PermissionTypeEnum

Permission type

ValuesREAD_ONLYREAD_WRITE

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/osd \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Add a data stream permission to a roleDeprecated

POST
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/stream

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Grants the role permission on a data stream.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

streamId
required
stringuuid

Stream ID

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response
409objectError 409 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/stream \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Delete a roleDeprecated

DELETE
/1.0/dbaas/logs/{serviceName}/role/{roleId}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Deletes the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Remove a role memberDeprecated

DELETE
/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Removes a member from the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

username
required
string

Username

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string, username = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Delete a role permissionDeprecated

DELETE
/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/{permissionId}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Deletes the role permission.

Path parameters

permissionId
required
stringuuid

Permission ID

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses permissionId = 00000000-0000-0000-0000-000000000000, roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/permission/{permissionId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Update a roleDeprecated

PUT
/1.0/dbaas/logs/{serviceName}/role/{roleId}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Updates the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

Request body (required)

description
required
string

Description

name
required
string

Name

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

Update a role memberDeprecated

PUT
/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username}

Deprecated since Sep 17, 2025, will be removed on Sep 17, 2026.

Updates a member of the role.

Path parameters

roleId
required
stringuuid

Role ID

serviceName
required
string

Service name

username
required
string

Username

Request body (required)

note
string

Custom note

Response

200Operationsuccessful operation
aliasId
read-only
stringuuid

Alias used

createdAt
read-only
stringdate-time

Operation creation

dashboardId
read-only
stringuuid

Dashboard used

encryptionKeyId
read-only
stringuuid

Encryption key used

indexId
read-only
stringuuid

Index used

inputId
read-only
stringuuid

Input used

operationId
read-only
stringuuid

Operation ID

osdId
read-only
stringuuid

OpenSearch Dashboards used

roleId
read-only
stringuuid

Role used

serviceName
read-only
string

Service name

state
read-only
OperationStateEnum

Operation status

ValuesFAILUREPENDINGRECEIVEDRETRYREVOKEDRUNNINGSTARTEDSUCCESS
streamId
read-only
stringuuid

Stream used

subscriptionId
read-only
stringuuid

Subscription used

tenantId
read-only
stringuuid

Metrics tenant used

tokenId
read-only
stringuuid

Token used

updatedAt
read-only
stringdate-time

Operation last update

403objectError 403 response
404objectError 404 response

Example uses roleId = 00000000-0000-0000-0000-000000000000, serviceName = string, username = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/role/{roleId}/member/{username} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "aliasId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "dashboardId": "00000000-0000-0000-0000-000000000000",  "encryptionKeyId": "00000000-0000-0000-0000-000000000000",  "indexId": "00000000-0000-0000-0000-000000000000",  "inputId": "00000000-0000-0000-0000-000000000000",  "operationId": "00000000-0000-0000-0000-000000000000",  "osdId": "00000000-0000-0000-0000-000000000000",  "roleId": "00000000-0000-0000-0000-000000000000",  "serviceName": "string",  "state": "FAILURE",  "streamId": "00000000-0000-0000-0000-000000000000",  "subscriptionId": "00000000-0000-0000-0000-000000000000",  "tenantId": "00000000-0000-0000-0000-000000000000",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}