These are the docs for the Metabase master branch. Some features documented here may not yet be available in the latest release. Check out the docs for the latest version, Metabase v0.49.

Setting

/api/setting endpoints.

GET /api/setting/

Get all Settings and their values. You must be a superuser or have setting permission to do this. For non-superusers, a list of visible settings and values can be retrieved using the /api/session/properties endpoint.

GET /api/setting/:key

Fetch a single Setting.

PARAMS:

  • key keyword

PUT /api/setting/

Update multiple Settings values. If called by a non-superuser, only user-local settings can be updated.

PARAMS:

  • settings map from to

PUT /api/setting/:key

Create/update a Setting. If called by a non-admin, only user-local settings can be updated. This endpoint can also be used to delete Settings by passing nil for :value.

PARAMS:

  • key keyword

  • value


« Back to API index

Read docs for other versions of Metabase.

Thanks for your feedback!

See something that needs fixing? Propose a change.