v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011189403.1 MB

databaseConnections

Update a Database Connection

Update the specified Database Connection.<br/><br/>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.

patch/lib/database-connections/{id}

Path parameters

idstring required

The <code>id</code> of the Database Connection to update.

Request body

authType'configObj' | 'connectionString' | 'secret' | 'secrets' required

configObjstring

JSON configuration object for advanced SQL Server connection settings.

connectionStringstring

Database connection string with embedded credentials or server information.

connectionTimeoutinteger

Maximum time (in milliseconds) to wait when establishing the database connection.

credsSecretsstring

Name of the stored credentials secret containing username and password. Used with Oracle connections.

databaseType'mysql' | 'oracle' | 'postgres' | 'sqlserver' required

descriptionstring required

Brief description of the Database Connection.

idstring required

Unique identifier for the Database Connection.

passwordstring

Database password for authentication. Used with Oracle connections.

requestTimeoutinteger

Maximum time (in milliseconds) to wait for a database query to complete. Applies to SQL Server connections only.

tagsstring

Comma-separated list of tags for categorizing and filtering Database Connections.

textSecretstring

Name of the stored text secret containing the connection string.

userstring

Database username for authentication. Used with Oracle connections.

Example request

{
  "connectionString": "mysql://yourUsername:yourPassword@mysql.example.com:3306/production?ssl=true",
  "connectionTimeout": 10000,
  "credsSecrets": "oracle-production-credentials",
  "description": "Production MySQL database for customer data",
  "id": "mysql-prod-db",
  "password": "yourPassword",
  "requestTimeout": 30000,
  "tags": "production,mysql,customer-data",
  "textSecret": "mysql-production-connection",
  "user": "yourUsername"
}

Response

The updated Database Connection in a response envelope with <code>count</code> and <code>items</code>.

countinteger required

Number of Database Connections returned in the response envelope.

Example response

{
  "count": 1,
  "items": [
    {
      "connectionString": "mysql://yourUsername:yourPassword@mysql.example.com:3306/production?ssl=true",
      "connectionTimeout": 10000,
      "credsSecrets": "oracle-production-credentials",
      "description": "Production MySQL database for customer data",
      "id": "mysql-prod-db",
      "password": "yourPassword",
      "requestTimeout": 30000,
      "tags": "production,mysql,customer-data",
      "textSecret": "mysql-production-connection",
      "user": "yourUsername"
    }
  ]
}