---
title: config_option_update
full: true
_openapi:
  method: PUT
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >
          Added in version 2.4.


          Allows to modify some CKAN runtime-editable config options


          It takes arbitrary key, value pairs and checks the keys against the
          config options update schema. If some of the provided keys are not
          present in the schema a `ValidationError` is raised. The values are
          then validated against the schema, and if validation is passed, for
          each key, value config option:


          - It is stored on the `system_info` database table

          - The Pylons `config` object is updated.

          - The `app_globals` (`g`) object is updated (this only happens for
          options explicitly defined in the `app_globals` module.


          <Callout title="Note">You can see all available runtime-editable
          configuration options calling the `config_option_list()`
          action.</Callout>


          <Callout title="Note">Extensions can modify which configuration
          options are runtime-editable. For details, check [Making configuration
          options
          runtime-editable](https://docs.ckan.org/en/2.11/extensions/remote-config-update.html).</Callout>


          <Callout title="Warning" type="warn">You should only add config
          options that you are comfortable they can be edited during runtime,
          such as ones you've added in your own extension, or have reviewed the
          use of in core CKAN.</Callout>
---

{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}

Added in version 2.4.

Allows to modify some CKAN runtime-editable config options

It takes arbitrary key, value pairs and checks the keys against the config options update schema. If some of the provided keys are not present in the schema a `ValidationError` is raised. The values are then validated against the schema, and if validation is passed, for each key, value config option:

- It is stored on the `system_info` database table
- The Pylons `config` object is updated.
- The `app_globals` (`g`) object is updated (this only happens for options explicitly defined in the `app_globals` module.

<Callout title="Note">You can see all available runtime-editable configuration options calling the `config_option_list()` action.</Callout>

<Callout title="Note">Extensions can modify which configuration options are runtime-editable. For details, check [Making configuration options runtime-editable](https://docs.ckan.org/en/2.11/extensions/remote-config-update.html).</Callout>

<Callout title="Warning" type="warn">You should only add config options that you are comfortable they can be edited during runtime, such as ones you've added in your own extension, or have reviewed the use of in core CKAN.</Callout>


<APIPage document={"./lib/openapi.yml"} operations={[{"path":"config_option_update","method":"put"}]} />