Saved filters
Saved agent list filters.
All paths are relative to the base path /api/v1 (same origin as the UI). Authentication, roles, pagination and the error format are described in the overview; the types are on the page Data types.
| Operation | Request | Permission |
|---|---|---|
| Own and shared saved filters | GET /saved-filters | read (viewer) |
| Save a filter | POST /saved-filters | saved_filters:write (viewer) |
| Delete an own saved filter | DELETE /saved-filters/{id} | saved_filters:write (viewer) |
Own and shared saved filters
GET /api/v1/saved-filters
Operation listSavedFilters. Permission read (lowest role: viewer).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
page | query | string | no | Default agents. |
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
| 200 | Saved filters | application/json | SavedFilterList |
| 401 | Not authenticated (code unauthorized) | application/problem+json | Problem |
Save a filter
POST /api/v1/saved-filters
Operation createSavedFilter. Permission saved_filters:write (lowest role: viewer).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
X-CSRF-Token | header | string | no | Required for cookie-authenticated mutating requests (value of cookie myriarch_csrf). |
Request body
Content type application/json, required. Type: CreateSavedFilterRequest.
{
"name": "string",
"page": "agents",
"query": {},
"shared": false
}
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
| 201 | Created | application/json | SavedFilter |
| 409 | Conflict (code conflict) | application/problem+json | Problem |
| 422 | Validation failed (code validation_failed, details in issues) | application/problem+json | Problem |
Delete an own saved filter
DELETE /api/v1/saved-filters/{id}
Operation deleteSavedFilter. Permission saved_filters:write (lowest role: viewer).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Format uuid. |
X-CSRF-Token | header | string | no | Required for cookie-authenticated mutating requests (value of cookie myriarch_csrf). |
Responses
| Status | Description | Content type | Type |
|---|---|---|---|
| 204 | Deleted | - | - |
| 404 | Not found (code not_found) | application/problem+json | Problem |