brandon/oam
1
0
Fork 0
mirror of https://gitea.com/mcereda/oam.git synced 2026-02-08 21:34:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(redash): improve api section

Browse Source
This commit is contained in:
Michele Cereda
2026-02-04 00:13:07 +01:00
parent 120a45693a
commit 2dc60fad91
1 changed files with 22 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
knowledge base/redash.md
View File

@@ -1,11 +1,6 @@
# Redash # Redash
> TODO Dashboard visualization tool.
Intro
<!-- Remove this line to uncomment if used
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr) 1. [TL;DR](#tldr)
1. [Authentication](#authentication) 1. [Authentication](#authentication)
@@ -18,6 +13,8 @@ Intro
## TL;DR ## TL;DR
Allows querying multiple _data sources_ at once.
Settings are read by `redash.settings` from environment variables.<br/> Settings are read by `redash.settings` from environment variables.<br/>
Most installations set them in `/opt/redash/.env`. Official container images require that `.env` file in the root Most installations set them in `/opt/redash/.env`. Official container images require that `.env` file in the root
directory.<br/> directory.<br/>
@@ -192,7 +189,25 @@ Refer [LDAP/AD Authentication].
Refer [API]. Refer [API].
Prefer acting on them via [getredash/redash-toolbelt]. Prefer acting on them using [getredash/redash-toolbelt].
<details style='padding: 0 0 1rem 1rem'>
<summary>Configuration</summary>
The `/api/config` endpoint does **not** require authentication.<br/>
The `/api/session` endpoint **does** require it.
```plaintext
GET /api/config
GET /api/session
```
```sh
curl --url 'https://redash.example.org/api/config'
curl --url 'https://redash.example.org/api/session' --header 'Authorization: Key AA…99'
```
</details>
<details style='padding: 0 0 1rem 1rem'> <details style='padding: 0 0 1rem 1rem'>
<summary>Data sources</summary> <summary>Data sources</summary>