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

OpenSearch Dashboards

All operations require authentication.

6 operationsv1/dbaas/logs
OpenAPI
Agent setup

List OpenSearch DashboardsProduction

GET
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd

Returns the OpenSearch Dashboards of the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

Query parameters

iamTags
object

Filter resources on IAM tags

Response

200string[]successful operation
404objectError 404 response

Example uses serviceName = string

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

Get an OpenSearch Dashboards instanceProduction

GET
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId}

Returns the OpenSearch Dashboards instance.

Path parameters

osdId
required
stringuuid

Osd ID

serviceName
required
string

Service name

Response

200OsdWithIAMsuccessful operation
createdAt
read-only
stringdate-time

OpenSearch Dashboards creation

deliveryStatus
read-only
DeliveryStatusEnum

Status of the delivering process

ValuesDELETINGDELIVERINGREADYUPDATING
description
read-only
string

OpenSearch Dashboards description

iam
read-only
ResourceMetadata

IAM resource metadata

isEditable
read-only
boolean

Indicates if you are allowed to edit entry

name
read-only
string

OpenSearch Dashboards name

osdId
read-only
stringuuid

OpenSearch Dashboards ID

updatedAt
read-only
stringdate-time

OpenSearch Dashboards last update

404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "createdAt": "2024-01-01T12:00:00Z",  "deliveryStatus": "DELETING",  "description": "string",  "iam": {    "displayName": "string",    "id": "00000000-0000-0000-0000-000000000000",    "state": "EXPIRED",    "tags": {      "key": "string"    },    "urn": "string"  },  "isEditable": true,  "name": "string",  "osdId": "00000000-0000-0000-0000-000000000000",  "updatedAt": "2024-01-01T12:00:00Z"}

List OpenSearch Dashboards URLsProduction

GET
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId}/url

Returns the OpenSearch Dashboards URLs of the Logs Data Platform service.

Path parameters

osdId
required
stringuuid

Osd ID

serviceName
required
string

Service name

Response

200Url[]successful operation
address
read-only
string

Web URI

type
read-only
UrlTypeEnum

Service type

ValuesCONSOLEELASTICSEARCH_APIGRAYLOG_APIGRAYLOG_WEBUIHTTP_GELFHTTP_TLS_GELFKIBANA_WEBUIOPENSEARCH_APIOSD_WEBUIPROMETHEUS_APISERVICE_DOMAINTCP_BEATSTCP_CAP_N_PROTOTCP_GELFTCP_LTSV_LINETCP_LTSV_NULTCP_RFC5424TCP_TLS_BEATSTCP_TLS_CAP_N_PROTOTCP_TLS_GELFTCP_TLS_LTSV_LINETCP_TLS_LTSV_NULTCP_TLS_RFC5424UDP_CAP_N_PROTOUDP_GELFUDP_LTSV_LINEUDP_LTSV_NULUDP_RFC5424WEB_SOCKET
404objectError 404 response

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

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId}/url \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "address": "string",    "type": "CONSOLE"  }]

Create an OpenSearch Dashboards instanceProduction

POST
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd

Creates an OpenSearch Dashboards instance on the Logs Data Platform service.

Path parameters

serviceName
required
string

Service name

Request body (required)

description
required
string

Description

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

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

Delete an OpenSearch Dashboards instanceProduction

DELETE
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId}

Deletes the OpenSearch Dashboards instance.

Path parameters

osdId
required
stringuuid

Osd 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 osdId = 00000000-0000-0000-0000-000000000000, serviceName = string

$ curl https://api.eu.ovhcloud.com/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId} \
  -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 an OpenSearch Dashboards instanceProduction

PUT
/1.0/dbaas/logs/{serviceName}/output/opensearch/osd/{osdId}

Updates the OpenSearch Dashboards instance.

Path parameters

osdId
required
stringuuid

Osd ID

serviceName
required
string

Service name

Request body (required)

description
required
string

Description

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 osdId = 00000000-0000-0000-0000-000000000000, serviceName = string

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