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

# Change database settings

> Changes engine settings for `mysql`, `mariadb` and `postgres` databases. Changing parameters (anything except the `postgis` and `pgvector` extensions) needs a bundle plan that allows it. Settings you send are merged with the current ones; send `null` to go back to the default. Team permission: `manage`.



## OpenAPI

````yaml /spec/dbaas.yaml patch /v1/databases/{databaseID}/settings
openapi: 3.0.1
info:
  title: Databases
  version: 1.0.0
  description: >
    Create managed databases, connect to them, change their plans and

    settings, back them up and restore them, and read their metrics and

    events.


    Supported types: `mysql`, `mariadb`, `postgres`, `mongodb`, `redis`,

    `mssql`, `elasticsearch`, `rabbitmq` and `clickhouse`. Databases are

    created in one of your private networks (see Networks in Apps &

    Deployments).


    ## Connecting


    `GET /v1/databases/{databaseID}` returns the connection details:


    - **From apps in the same network:** `hostname` and `internalPort`.

    - **Over the public network** (if `publicNetwork` is on):
    `network.node.host`
      and `port`.
    - **Credentials:** `username` and `root_password`.


    ## Team permissions


    With `teamID`, each endpoint needs one of the database permissions it

    lists (`view`, `operate` or `manage`). A permission from your role or a

    resource permission on that database both count.
servers:
  - url: https://api.liara.ir
security:
  - bearerAuth: []
tags:
  - name: Databases
    description: Create, list, inspect and delete databases.
  - name: Configuration
    description: Plans, scaling, settings, public network, password and control panel.
  - name: Backups
    description: Back up databases, download backups and import backup files.
  - name: Metrics & Events
    description: >-
      Resource usage, lifecycle events and the progress of background
      operations.
paths:
  /v1/databases/{databaseID}/settings:
    patch:
      tags:
        - Configuration
      summary: Change database settings
      description: >-
        Changes engine settings for `mysql`, `mariadb` and `postgres` databases.
        Changing parameters (anything except the `postgis` and `pgvector`
        extensions) needs a bundle plan that allows it. Settings you send are
        merged with the current ones; send `null` to go back to the default.
        Team permission: `manage`.
      operationId: updateDatabaseSettings
      parameters:
        - $ref: '#/components/parameters/TeamID'
        - $ref: '#/components/parameters/DatabaseID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - type
              properties:
                type:
                  type: string
                  description: Must match the database's type.
                  enum:
                    - mysql
                    - mariadb
                    - postgres
                options:
                  oneOf:
                    - $ref: '#/components/schemas/MySQLSettings'
                    - $ref: '#/components/schemas/PostgresSettings'
            example:
              type: postgres
              options:
                maxConnections: 200
                pgvector: true
      responses:
        '200':
          description: The settings were saved. The response body is empty.
        '400':
          description: >-
            The body, the database ID or `teamID` is invalid, or the PostgreSQL
            version is unknown.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The PostgreSQL version is deprecated (only extension changes are
            allowed), or, with `teamID`, you aren't a member (`team_not_found`)
            or lack the permission (`no_permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 403
                error: Forbidden
                message: Cannot modify settings for deprecated PostgreSQL version.
                data: null
        '404':
          description: No database of this type with this ID, or it's frozen.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '428':
          description: Your bundle plan doesn't allow changing parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 428
                error: Precondition Required
                message: This database plan does not support editing parameters.
                data:
                  code: parameter_limit
components:
  parameters:
    TeamID:
      name: teamID
      in: query
      required: false
      description: >-
        Run the request in the context of a team you belong to, instead of your
        personal account.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000002'
    DatabaseID:
      name: databaseID
      in: path
      required: true
      description: The database's `_id`.
      schema:
        $ref: '#/components/schemas/ObjectID'
      example: '000000000000000000000300'
  schemas:
    MySQLSettings:
      type: object
      title: MySQL / MariaDB
      properties:
        maxConnections:
          type: number
          nullable: true
        netBufferLength:
          type: number
          nullable: true
        maxAllowedPacket:
          type: number
          nullable: true
        connectTimeout:
          type: number
          nullable: true
        maxJoinSize:
          type: number
          nullable: true
        eventScheduler:
          type: string
          enum:
            - 'ON'
            - 'OFF'
    PostgresSettings:
      type: object
      title: PostgreSQL
      properties:
        connectTimeout:
          type: number
          minimum: 2
          nullable: true
        clientEncoding:
          type: string
          nullable: true
        maxConnections:
          type: number
          nullable: true
        sharedBuffers:
          type: number
          nullable: true
        postgis:
          type: boolean
        pgvector:
          type: boolean
    Error:
      type: object
      description: Standard error body.
      properties:
        statusCode:
          type: integer
        error:
          type: string
          description: HTTP status text.
        message:
          type: string
          description: What went wrong.
        data:
          type: object
          nullable: true
          description: >-
            Extra details. When present, `code` is a stable, machine-readable
            error code.
          properties:
            code:
              type: string
    ObjectID:
      type: string
      pattern: ^[0-9a-fA-F]{24}$
      description: 24-character hexadecimal ID.
    AuthError:
      type: object
      description: Error body returned when the API token is rejected.
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: The API token is missing, invalid or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthError'
          example:
            error: Unauthorized.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send your API token as `Authorization: Bearer <api-token>`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.