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

Tokens

All operations require authentication.

4 operationsv1/dbaas/logs
OpenAPI
Agent setup

List tokensDeprecated

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

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

Returns the tokens 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}/token \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  "00000000-0000-0000-0000-000000000000"]

Get a tokenDeprecated

GET
/1.0/dbaas/logs/{serviceName}/token/{tokenId}

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

Returns the token.

Path parameters

serviceName
required
string

Service name

tokenId
required
stringuuid

Token ID

Response

200Tokensuccessful operation
clusterId
read-only
stringuuid

Cluster ID

createdAt
read-only
stringdate-time

Token creation

name
read-only
string

Token name

tokenId
read-only
stringuuid

Token ID

updatedAt
read-only
stringdate-time

Token last update

value
read-only
string

Token value

403objectError 403 response
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/token/{tokenId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "clusterId": "00000000-0000-0000-0000-000000000000",  "createdAt": "2024-01-01T12:00:00Z",  "name": "string",  "tokenId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z",  "value": "string"}

Create a tokenDeprecated

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

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

Creates a token on the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

Request body (required)

clusterId
stringuuid

Cluster ID

name
required
string

Token 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}/token \
  -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 tokenDeprecated

DELETE
/1.0/dbaas/logs/{serviceName}/token/{tokenId}

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

Deletes the token.

Path parameters

serviceName
required
string

Service name

tokenId
required
stringuuid

Token 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

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/token/{tokenId} \
  -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"}