Skip to main content
PUT
Replace a saved Logs search (browser session)

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

application_id
string
required
search_id
string
required

Body

application/json

A whole saved search: its name and its query, both required. A replacement replaces both; there is no partial change.

name
string
required

The name the menu shows. It is trimmed and each run of spaces inside it made one space; it must then be 1 to 80 characters with no control character, and no other search of the application may have a name that reads the same with capitals aside.

query
object
required

What a saved search searches with, in the Logs page's own shape. Every member is required and no other is kept: a member the platform does not know is refused, never dropped.

Response

The search as it is now, with who changed it last

One search saved for an application's Logs: a name and the query the Logs page searches with. The platform stores the query and never runs it.

id
string<uuid>
required

The search's id.

name
string
required

The name the menu shows: trimmed, each run of spaces inside it one space, 1 to 80 characters. Unique within the application with capitals aside.

Required string length: 1 - 80
query
object | null
required

The query the Logs page searches with; null exactly when query_state is unreadable.

query_state
enum<string>
required

readable: the stored query is one the rules accept, and query holds it. unreadable: the stored query is one the rules no longer accept (a member a later release removed, a rule it tightened, a row changed by hand); the search is still listed with its name and who saved it, so it can be replaced or removed, and query is null. Replacing it stores the new query and makes it readable.

Available options:
readable,
unreadable
created_by
object
required

Who saved or last changed a saved search.

created_at
string<date-time>
required

When the search was saved, in UTC.

updated_by
object
required

Who saved or last changed a saved search.

updated_at
string<date-time>
required

When the search was last changed, in UTC; created_at when it never was.