CRcriblio
databaseConnections

List all Database Connections

Changed on

Get a list of all Database Connections.

get/lib/database-connections

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://login.cribl.cloud/oauth/token

Query parameters

databaseType'mysql' | 'oracle' | 'postgres' | 'snowflake' | 'sqlserver' | 'teradata'

Filter results by database engine type. Use this parameter to return only Database Connections for the specified engine.

limitinteger

Maximum number of Database Connections to return in the response for this request. Use with <code>offset</code> to paginate the response into manageable batches.

offsetinteger

Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches.

Response

Database Connections returned 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,
      "credentialsSecret": "mssql-production-credentials",
      "credsSecrets": "oracle-production-credentials",
      "description": "Production MySQL database for customer data",
      "host": "'myId-dt5egqq7iq1hj6kh.env.trial.example.com'\nHostname, currently intended for Teradata",
      "id": "mysql-prod-db",
      "password": "yourPassword",
      "requestTimeout": 30000,
      "sslmode": "VERIFY-FULL",
      "tags": "production,mysql,customer-data",
      "textSecret": "mysql-production-connection",
      "user": "yourUsername"
    }
  ]
}

Changes

  • fd542bb248a2Revision changes
    • warning

      added the new keypair enum value to the // response property for the response status

    • warning

      added the new snowflake enum value to the // response property for the response status

    • info

      added the new enum value snowflake to the query request parameter databaseType

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 3816b6fddba1Revision changes
    • warning

      added the new teradata enum value to the // response property for the response status

    • info

      added the new enum value teradata to the query request parameter databaseType

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status