Skip to content

V0.29: update api keys to add * action #1863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 29, 2022
Merged

V0.29: update api keys to add * action #1863

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
301bf65
v0.29: update keys
maryamsulemani97 Sep 6, 2022
ecdcd38
update keys.md
maryamsulemani97 Sep 6, 2022
13b877f
update based on review
maryamsulemani97 Sep 6, 2022
e8fc94b
Update reference/api/keys.md
maryamsulemani97 Sep 6, 2022
91b9f9f
update based on review
maryamsulemani97 Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions reference/api/keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,13 @@ Since the `key` field depends on the master key, it is computed at runtime and t

**Type**: Array
**Default value**: N/A
**Description**: An array of API actions permitted for the key, represented as strings. API actions are only possible on authorized [`indexes`](#indexes). `["*"]` for all actions
**Description**: An array of API actions permitted for the key, represented as strings. API actions are only possible on authorized [`indexes`](#indexes). `["*"]` for all actions.

::: warning
We do not recommend creating keys that can perform all actions.
:::

You can use `*` as a wildcard to access all endpoints for the `documents`, `indexes`, `tasks`, `settings`, `stats` and `dumps` actions. For example, `documents.*` gives access to all document actions.

| Name | Description |
| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand All @@ -71,7 +77,7 @@ Since the `key` field depends on the master key, it is computed at runtime and t
| **`indexes.create`** | Provides access to the [create index](/reference/api/indexes.md#create-an-index) endpoint |
| **`indexes.get`** | Provides access to the [get one index](/reference/api/indexes.md#get-one-index) and [list all indexes](/reference/api/indexes.md#list-all-indexes) endpoints. **Non-authorized `indexes` will be omitted from the response** |
| **`indexes.update`** | Provides access to the [update index](/reference/api/indexes.md#update-an-index) endpoint |
| **`indexes.delete`** | Provides access to the [delete index](/reference/api/indexes.md#delete-an-index) endpoint |
| **`indexes.delete`** | Provides access to the [delete index](/reference/api/indexes.md#delete-an-index) endpoints |
| **`tasks.get`** | Provides access to the [get one task](/reference/api/tasks.md#get-one-task) and [get tasks](/reference/api/tasks.md#get-tasks) endpoints. **Tasks from non-authorized `indexes` will be omitted from the response** |
| **`settings.get`** | Provides access to the [get settings](/reference/api/settings.md#get-settings) endpoint and equivalents for all subroutes |
| **`settings.update`** | Provides access to the [update settings](/reference/api/settings.md#update-settings) and [reset settings](/reference/api/settings.md#reset-settings) endpoints and equivalents for all subroutes |
Expand Down