---
title: "Add database observability to a database"
method: POST
path: "/v1/dbo/databases"
tags: ["dbo"]
---

# Add database observability to a database

`POST /v1/dbo/databases`

## Request body

- DboObserveDatabaseRequest
  - `name` string, required — Name for the observed database entity
  - `agentId` string, required — Swo Agent ID where the plugin(s) for observing database server should run
  - `dbType` 'mysql' | 'mongo' | 'mssql' | 'redis' | 'pgsql' | 'oracle', required
  - `authMethod` 'basic' | 'awsiam' | 'windows' | 'entraclientsecret' | 'entraclientcert' | 'cert', required
  - `captureMethod` 'sniffer' | 'poll' | 'profiler' | 'slow-log'
  - `configOptions` CommonKeyValuePair[] — Optional advanced configuration options for plugins, e.g. disable-sampling set to true
    - `key` string, required — Key.
    - `value` string, required — Value.
  - `dbConnOptions` DboDatabaseConnectionOptions, required
    - `host` string, required — Database server host
    - `port` string — Database server port
    - `dbname` string — Database schema name
    - `encryptedCredentials` string — Encrypted credentials for connecting to the database server when using basic authentication (username, password) can be generated using this command: ./dbo-headless-installer -swoparams=<SwoParamasJsonFile> --encrypt-creds --user=<USERNAME> --password=<PASSWORD> Use the dbo-headless-installer binary located at: https://agent-binaries.cloud.solarwinds.com/?prefix=dbo-headless-installer/latest/
    - `user` string — Username for connecting to database server needed only for auth methods other than basic auth
    - `sslEnabled` boolean — Enable ssl when agent connects to database server
    - `sslOptions` DboDatabaseSslOptions
      - `sslMode` 'require' | 'verify-ca' | 'verify-full', required
      - `sslCAPath` string — CA file path
      - `sslKeyPath` string — SSL key file path
      - `sslCertPath` string — SSL cert file path
    - `cloudRegion` string — Cloud region in case of database managed by cloud provider, required for IAM authentication
    - `bindings` string — binding for packet sniffing for sniffer captureMethod (on-host), example: 0.0.0.0:6379,[::]:6379
    - `additionalOptions` CommonKeyValuePair[] — Additional database-type-specific connection options as key-value pairs. For Oracle: service_name (Oracle service name), sid (Oracle SID).
      - `key` string, required — Key.
      - `value` string, required — Value.
  - `tags` CommonKeyValuePair[] — Tags for observed database entity
    - `key` string, required — Key.
    - `value` string, required — Value.

## Response `201`

The request has succeeded and a new resource has been created as a result.

- object
  - `id` string, required — Resource identifier.

## Other responses

- `400` — The server could not understand the request due to invalid syntax.
- `401` — Access is unauthorized.
- `403` — Access is forbidden.
- `500` — Server error

---

[API](https://skmtc.net/solarwinds/apis/solarwinds-observability.md) · [All operations](https://skmtc.net/solarwinds/apis/solarwinds-observability/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solarwinds/solarwinds-observability/revisions/994e5ca64961/schema)