Skip to content
Snippets Groups Projects
Unverified Commit b26d3386 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

update api docs (#28844)

parent bcd13354
No related branches found
No related tags found
No related merge requests found
......@@ -26,6 +26,7 @@ _* indicates endpoints used for features available on [paid plans](https://www.m
- [Action](api/action.md)
- [Activity](api/activity.md)
- [Advanced config logs*](api/ee/advanced-config-logs.md)
- [Advanced permissions application*](api/ee/advanced-permissions-application.md)
- [Alert](api/alert.md)
- [Audit app user*](api/ee/audit-app-user.md)
......
......@@ -22,10 +22,15 @@ Fetch a list of all Collections that the current user has read permissions for (
By default, this returns non-archived Collections, but instead you can show archived ones by passing
`?archived=true`.
By default, admin users will see all collections. To hide other user's collections pass in
`?exclude-other-user-collections=true`.
### PARAMS:
* **`archived`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
* **`exclude-other-user-collections`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
* **`namespace`** value may be nil, or if non-nil, value must be a non-blank string.
## `GET /api/collection/:id`
......@@ -157,6 +162,8 @@ Similar to `GET /`, but returns Collections in a tree structure, e.g.
* **`exclude-archived`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
* **`exclude-other-user-collections`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
* **`namespace`** value may be nil, or if non-nil, value must be a non-blank string.
## `POST /api/collection/`
......
---
title: "Advanced config logs"
summary: |
/api/logs endpoints.
These endpoints are meant to be used by admins to download logs before entries are auto-removed after the day limit.
For example, the `query_execution` table will have entries removed after 30 days by default, and admins may wish to
keep logs externally for longer than this retention period.
---
# Advanced config logs
/api/logs endpoints.
These endpoints are meant to be used by admins to download logs before entries are auto-removed after the day limit.
For example, the `query_execution` table will have entries removed after 30 days by default, and admins may wish to
keep logs externally for longer than this retention period.
## `GET /api/ee/advanced-config/logs/query_execution/:yyyy-mm`
Fetch rows for the month specified by `:yyyy-mm` from the query_execution logs table.
Must be a superuser.
### PARAMS:
* **`yyyy-mm`**
---
[<< Back to API index](../../api-documentation.md)
\ No newline at end of file
......@@ -21,7 +21,7 @@ Update the `login_attributes` for a User.
* **`id`**
* **`login_attributes`** value must be a valid user attributes map (name -> value)
* **`login_attributes`** nullable value must be a valid user attributes map (name -> value)
---
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment