> ## Documentation Index
> Fetch the complete documentation index at: https://docs.instacloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get database metrics

> **Token scope:** `account` · `org` · `project` — read-only tokens allowed.

Point-in-time DB metrics (connections, size, deadlocks, tuple churn, cache hit). Provider-specific; may wake a suspended database.



## OpenAPI

````yaml /openapi/project.json get /projects/{projectId}/database/metrics
openapi: 3.1.0
info:
  title: InstaCloud API — Project level
  version: 0.1.0
  description: >-
    Endpoints under `/projects/{projectId}`: branches, services, deploys,
    secrets, databases, storage, cron, observability, governance. Callable with
    any token whose binding covers the project.


    Generated from the platform's own OpenAPI document
    (https://api.instacloud.com/openapi.json); see the [API
    overview](/reference/api/overview) for authentication and token scopes.
servers:
  - url: https://api.instacloud.com
    description: InstaCloud
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Projects inside an organization.
  - name: Branches
    description: >-
      Branch environments of a project: isolated database, storage and compute
      per branch.
  - name: Services
    description: 'Services on a branch: compute, postgres, storage and managed databases.'
  - name: Deploy
    description: Deploy an image or a source to a compute service.
  - name: Compute
    description: Build output of a compute service.
  - name: Secrets
    description: User secrets, service credentials and how they bind into compute env.
  - name: Database
    description: Postgres databases, extensions, credentials and ad-hoc SQL.
  - name: Storage
    description: Objects in a storage service.
  - name: Backups
    description: Database backups and restores.
  - name: Cron
    description: Scheduled HTTP calls against a service or an external URL.
  - name: Observability
    description: Logs, metrics, deploy events and database insight.
  - name: Governance
    description: Per-project agent policy and the approval queue.
  - name: Audit
    description: The project's event timeline, including agent-ingested events.
  - name: Domains
    description: >-
      Domains bought through InstaCloud, bring-your-own zones and their DNS
      records.
  - name: Billing
    description: Usage, cycles, invoices and credits.
  - name: Templates
    description: Deploy a template into a project.
paths:
  /projects/{projectId}/database/metrics:
    get:
      tags:
        - Observability
      summary: Get database metrics
      description: >-
        **Token scope:** `account` · `org` · `project` — read-only tokens
        allowed.


        Point-in-time DB metrics (connections, size, deadlocks, tuple churn,
        cache hit). Provider-specific; may wake a suspended database.
      operationId: getDatabaseMetrics
      parameters:
        - schema:
            type: string
          in: query
          name: branch
          required: false
          description: branch name (default branch if omitted)
        - schema:
            type: string
          in: query
          name: group
          required: false
          description: 'postgres service name (default: the sole postgres service)'
        - schema:
            format: uuid
            type: string
          in: path
          name: projectId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DbMetricsSnapshot'
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DbMetricsSnapshot:
      type: object
      properties:
        connections:
          $ref: '#/components/schemas/DbConnections'
        dbSizeBytes:
          type: number
        deadlocks:
          type: number
        tuples:
          $ref: '#/components/schemas/DbTuples'
        cacheHitRatio:
          description: >-
            0..1; blks_hit/(blks_hit+blks_read). Omitted when unmeasurable
            (suspended instance or no cache traffic yet)
          type: number
        state:
          description: provider instance state (e.g. running/suspended) when known
          type: string
        serverVersion:
          description: postgres server version, e.g. "16.14", when measured
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    DbConnections:
      type: object
      properties:
        active:
          type: integer
        idle:
          type: integer
        total:
          type: integer
        max:
          type: integer
    DbTuples:
      type: object
      properties:
        inserted:
          type: integer
        updated:
          type: integer
        deleted:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session access JWT or an API token (`insta_<prefix>_<secret>`).

````