---
updatedAt: 2026-08-26T11:11:10.000Z
agentTools:
  projectIndex: https://docs.cast.ai/llms.txt
---

# Report database instance configuration settings.

Report latest known database instance configuration

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "servers": [
    {
      "url": "https://api.cast.ai/",
      "description": "US endpoint"
    },
    {
      "url": "https://api.eu.cast.ai/",
      "description": "EU endpoint"
    }
  ],
  "info": {
    "title": "Database Optimizer",
    "version": "0.0.1"
  },
  "security": [
    {
      "BearerAuth": []
    },
    {
      "ApiKeyAuth": []
    }
  ],
  "paths": {
    "/database-optimizer/advisor/v1alpha/organizations/{organizationId}/database-instances/{databaseInstanceId}/configuration": {
      "post": {
        "tags": [
          "DatabaseInstanceConfigAPI"
        ],
        "summary": "Report database instance configuration settings.",
        "description": "Report latest known database instance configuration",
        "operationId": "DatabaseInstanceConfigAPI_ReportDatabaseInstanceConfig",
        "parameters": [
          {
            "name": "organizationId",
            "in": "path",
            "description": "Organization identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "databaseInstanceId",
            "in": "path",
            "description": "Database instance identifier",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportDatabaseInstanceConfigRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportDatabaseInstanceConfigResponse"
                }
              }
            }
          },
          "default": {
            "description": "Default error response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Status"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    },
    "schemas": {
      "DatabaseInstanceConfig": {
        "required": [
          "databaseVersion",
          "maxConnections"
        ],
        "type": "object",
        "properties": {
          "databaseVersion": {
            "type": "string",
            "description": "The version of the database"
          },
          "maxConnections": {
            "type": "integer",
            "description": "Max number of configured connections a database instance can have",
            "format": "uint32"
          },
          "settings": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InstanceSetting"
            },
            "description": "Full snapshot of database configuration settings collected by the agent\n (all pg_settings rows for Postgres, all SHOW GLOBAL VARIABLES for MySQL).\n Empty when reported by an older agent that only sends version and max_connections."
          }
        },
        "description": "Database instance config collected by the DB agent"
      },
      "GoogleProtobufAny": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string",
            "description": "The type of the serialized message."
          }
        },
        "additionalProperties": true,
        "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message."
      },
      "InstanceSetting": {
        "required": [
          "name",
          "value"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the setting (e.g. \"shared_buffers\", \"innodb_buffer_pool_size\")"
          },
          "value": {
            "type": "string",
            "description": "Current value of the setting as reported by the server, in the server's\n native representation (e.g. \"16384\" for shared_buffers, meaning 16384 x 8kB)"
          },
          "unit": {
            "type": "string",
            "description": "Unit the value is expressed in, when the server reports it\n (e.g. \"8kB\" for Postgres shared_buffers; empty for MySQL)"
          },
          "source": {
            "type": "string",
            "description": "Where the value comes from (e.g. \"default\", \"configuration file\",\n \"override\" for Postgres; empty for MySQL)"
          }
        },
        "description": "A single database configuration setting"
      },
      "ReportDatabaseInstanceConfigRequest": {
        "required": [
          "organizationId",
          "databaseInstanceId",
          "config"
        ],
        "type": "object",
        "properties": {
          "organizationId": {
            "type": "string",
            "description": "Organization identifier"
          },
          "databaseInstanceId": {
            "type": "string",
            "description": "Database instance identifier"
          },
          "config": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DatabaseInstanceConfig"
              }
            ],
            "description": "Database instance config"
          }
        },
        "description": "Request to report latest known database instance configuration"
      },
      "ReportDatabaseInstanceConfigResponse": {
        "type": "object",
        "properties": {},
        "description": "Response from reporting latest known database instance configuration"
      },
      "Status": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
            "format": "int32"
          },
          "message": {
            "type": "string",
            "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
          },
          "details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GoogleProtobufAny"
            },
            "description": "A list of messages that carry the error details.  There is a common set of message types for APIs to use."
          }
        },
        "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)."
      }
    }
  },
  "tags": [
    {
      "name": "DatabaseInstanceConfigAPI",
      "description": "DatabaseInstanceConfigAPI is an API for handling database instance configuration"
    }
  ]
}
```