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

# Get database.

> 
    ROLES: RESOURCE_READ,RESOURCE_WRITE,RESOURCE_ADMIN
    USER: true
    SERVICE ACCOUNT: true
    



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/databases/{databaseId}
openapi: 3.0.0
info:
  title: RevoEngine Platform API
  description: Official RevoEngine Platform API documentation.
  version: 1.3.0
  contact:
    name: Support
    email: support@revoengine.com
  termsOfService: https://docs.revoengine.com/tos
servers:
  - url: https://api.revoengine.com
    description: Production
security: []
tags:
  - name: Accounts
    description: Users, service accounts, API keys, status, and platform access.
    externalDocs:
      description: Identity and access guide
      url: https://docs.revoengine.com/operate/identity-and-access
  - name: Activity
    description: Snapshot-backed activity and version history.
    externalDocs:
      description: Observability guide
      url: https://docs.revoengine.com/operate/observability
  - name: Agent Memory
    description: Administrative access to durable Agent memory.
    externalDocs:
      description: Agent memory and workspaces guide
      url: https://docs.revoengine.com/ai/memory-and-workspaces
  - name: Agent Plugins
    description: Agent plugin definitions, synchronization, testing, and lifecycle.
    externalDocs:
      description: Agent plugins guide
      url: https://docs.revoengine.com/ai/plugins
  - name: Agents
    description: >-
      Agent definitions, runs, sessions, inboxes, memory, tools, workspaces, and
      lifecycle.
    externalDocs:
      description: Autonomous Agents guide
      url: https://docs.revoengine.com/ai/agents
  - name: Assistant
    description: >-
      Assistant threads, messages, responses, goals, reports, sharing,
      attachments, and control.
    externalDocs:
      description: Assistant guide
      url: https://docs.revoengine.com/ai/assistant
  - name: Automation
    description: >-
      Jobs, templates, schedules, events, webhooks, execution history, and
      lifecycle.
    externalDocs:
      description: Automation guide
      url: https://docs.revoengine.com/operate/automation
  - name: Chat
    description: Collaborative chat threads, messages, reactions, uploads, and attachments.
    externalDocs:
      description: Team Chat guide
      url: https://docs.revoengine.com/operate/chat
  - name: Component deployments
    description: >-
      Custom Node.js runtime deployment attempts, readiness, activation, and
      rollback.
    externalDocs:
      description: Custom Node.js guide
      url: https://docs.revoengine.com/build/custom-nodejs
  - name: Components
    description: Components, elements, versions, validation, activation, and lifecycle.
    externalDocs:
      description: Components guide
      url: https://docs.revoengine.com/build/components
  - name: Config
    description: Instance configuration, usage, logs, and cache administration.
    externalDocs:
      description: Instance settings guide
      url: https://docs.revoengine.com/platform/instance-settings
  - name: Database Cache
    description: Instance Database cache values and statistics.
    externalDocs:
      description: Database Cache guide
      url: https://docs.revoengine.com/operate/database-cache
  - name: Database Views
    description: Database Views, previews, refreshes, exports, and controlled data actions.
    externalDocs:
      description: Database Views guide
      url: https://docs.revoengine.com/operate/database-views
  - name: Databases
    description: Database definitions, data, audits, exports, cloning, and lifecycle.
    externalDocs:
      description: Databases guide
      url: https://docs.revoengine.com/operate/databases
  - name: Endpoints
    description: >-
      Endpoint definitions, activation, validation, generated OpenAPI, and
      statistics.
    externalDocs:
      description: Endpoints guide
      url: https://docs.revoengine.com/operate/endpoints
  - name: Files
    description: Compatibility file listing, preview, download, and deletion operations.
    externalDocs:
      description: Files compatibility guide
      url: https://docs.revoengine.com/operate/files
  - name: Groups
    description: Groups, membership, avatars, and lifecycle.
    externalDocs:
      description: Groups guide
      url: https://docs.revoengine.com/operate/groups
  - name: Me
    description: Current user profile, keys, avatar, and session information.
    externalDocs:
      description: Authentication guide
      url: https://docs.revoengine.com/developers/authentication
  - name: Preferences
    description: User and instance preference values.
    externalDocs:
      description: Platform UI guide
      url: https://docs.revoengine.com/platform/ui-tour
  - name: Role Groups
    description: Role groups, members, assigned roles, and lifecycle.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Roles
    description: Available platform roles and role details.
    externalDocs:
      description: Permissions guide
      url: https://docs.revoengine.com/operate/permissions
  - name: Search
    description: Cross-domain search over objects visible to the caller.
    externalDocs:
      description: Search and discovery guide
      url: https://docs.revoengine.com/platform/search
  - name: Secrets
    description: >-
      Secret definitions, revisions, activation, reveal, disable, and
      destruction.
    externalDocs:
      description: Secrets guide
      url: https://docs.revoengine.com/operate/secrets
  - name: Storage
    description: >-
      Storage workspaces, folders, objects, upload sessions, signed access, and
      lifecycle.
    externalDocs:
      description: Storage guide
      url: https://docs.revoengine.com/operate/storage
externalDocs:
  description: Documentation
  url: https://docs.revoengine.com
paths:
  /api/v1/databases/{databaseId}:
    get:
      tags:
        - Databases
      summary: Get database.
      description: |2-

            ROLES: RESOURCE_READ,RESOURCE_WRITE,RESOURCE_ADMIN
            USER: true
            SERVICE ACCOUNT: true
            
      operationId: DatabaseController_getOne
      parameters:
        - name: databaseId
          required: true
          in: path
          description: Provide databaseId.
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TruncateDatabaseDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseReadDto'
        '403':
          description: Forbidden.
        '404':
          description: Not found.
      security:
        - bearer: []
components:
  schemas:
    TruncateDatabaseDto:
      type: object
      properties:
        restartIdentity:
          type: boolean
          default: false
          description: >-
            Restart owned identity sequences after truncation. Keep false when
            generated keys must never be reused.
    DatabaseReadDto:
      type: object
      properties:
        databaseId:
          type: string
          format: uuid
        name:
          type: string
        category:
          type: string
          nullable: true
        desc:
          type: string
          nullable: true
        tags:
          nullable: true
          type: array
          items:
            type: string
        restricted:
          type: boolean
        audit:
          type: boolean
          description: Whether future row mutations are captured for this logical table.
        type:
          type: string
          enum:
            - TABLE
            - TABLE_PARTITIONED
        definition:
          type: array
          items:
            $ref: '#/components/schemas/DatabaseDefinition'
        partition:
          type: object
          nullable: true
        metadata:
          type: object
        groups:
          type: array
          items:
            type: object
        users:
          type: array
          items:
            type: object
        parent:
          type: string
          nullable: true
        master:
          type: string
          nullable: true
        version:
          type: number
        createdBy:
          type: string
          format: uuid
        createdAt:
          format: date-time
          type: string
        lastUpdateBy:
          type: string
          format: uuid
        lastUpdateAt:
          format: date-time
          type: string
        deletedAt:
          format: date-time
          type: string
          nullable: true
        deletedBy:
          type: string
          format: uuid
          nullable: true
      required:
        - databaseId
        - name
        - category
        - desc
        - tags
        - restricted
        - audit
        - type
        - definition
        - partition
        - groups
        - users
        - parent
        - master
        - version
        - createdBy
        - createdAt
        - lastUpdateBy
        - lastUpdateAt
        - deletedAt
        - deletedBy
    DatabaseDefinition:
      type: object
      properties:
        databaseDefinitionId:
          type: string
          description: Column id, required only for update.
        name:
          type: string
          description: Name.
          minLength: 1
          maxLength: 63
        desc:
          type: string
          description: Description.
          nullable: true
          maxLength: 200
        metadata:
          type: object
          description: >-
            Optional column metadata. Values may use any JSON type. Maximum 16
            KiB and 64 top-level keys. Top-level keys starting with "__" are
            reserved for backend use.
        type:
          type: string
          description: >-
            You need to specify type [SMALLINT,INTEGER,BIGINT,REAL,DOUBLE
            PRECISION,NUMERIC,JSON,JSONB,TEXT,UUID,DATE,TIME,TIMETZ,TIMESTAMP,TIMESTAMPTZ,BOOLEAN].
          enum:
            - SMALLINT
            - INTEGER
            - BIGINT
            - REAL
            - DOUBLE PRECISION
            - NUMERIC
            - JSON
            - JSONB
            - TEXT
            - UUID
            - DATE
            - TIME
            - TIMETZ
            - TIMESTAMP
            - TIMESTAMPTZ
            - BOOLEAN
        isPrimaryKey:
          type: boolean
          description: Provide if this column is primary key.
        isArray:
          type: boolean
          description: >-
            Provide if this column is array of provided type, primary keys
            cannot be arrays.
        isUnique:
          type: boolean
          description: >-
            Provide if this column should contain only unique values for entire
            table.
        isNullable:
          type: boolean
          description: Provide if this column should can contain NULL values or not.
        isIndex:
          type: boolean
          description: Provide if this column should should be index.
        default:
          description: 'Default: boolean, number, string'
          oneOf:
            - type: string
            - type: boolean
            - type: number
          nullable: true
        foreignReferences:
          description: Foreign references to other database definitions.
          nullable: true
          type: array
          items:
            $ref: '#/components/schemas/DatabaseDefinitionForeignReferences'
      required:
        - name
        - type
        - isPrimaryKey
        - isArray
        - isUnique
        - isNullable
        - isIndex
    DatabaseDefinitionForeignReferences:
      type: object
      properties:
        reference:
          description: >-
            You need to specify reference type
            [SMALLINT,INTEGER,BIGINT,REAL,DOUBLE
            PRECISION,NUMERIC,JSON,JSONB,TEXT,UUID,DATE,TIME,TIMETZ,TIMESTAMP,TIMESTAMPTZ,BOOLEAN].
          type: array
          items:
            $ref: '#/components/schemas/DatabaseDefinitionForeignReference'
        onUpdate:
          type: string
          description: >-
            You need to specify what happen on update of referenced table data,
            "none" will raise an error if there are records existing in this
            table that reference it.
          enum:
            - none
            - cascade
            - restrict
        onDelete:
          type: string
          description: >-
            You need to specify what happen on update of referenced table data,
            "none" will raise an error if there are records existing in this
            table that reference it.
          enum:
            - none
            - cascade
            - restrict
            - default
            - 'null'
      required:
        - reference
        - onUpdate
        - onDelete
    DatabaseDefinitionForeignReference:
      type: object
      properties:
        column:
          type: string
          description: Column.
          minLength: 1
          maxLength: 63
        targetDatabase:
          type: string
          description: Target database.
          minLength: 1
          maxLength: 63
        targetColumn:
          type: string
          description: Target column.
          minLength: 1
          maxLength: 63
      required:
        - column
        - targetDatabase
        - targetColumn
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      description: Bearer JWT token or API Key (sk-*).
      type: http

````