latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-17106135449.3 KB

dbc01f217b03

search-tools

Update Search Tool

Update a stored search tool. Omitted fields are left as-is; an explicit null clears them.

api_key follows the same rule: omit it to keep the stored key, send a new one to rotate, or send null to clear it (a keyless SearXNG backend). The row is locked FOR UPDATE so the expected_updated_at check and the write it guards are atomic. The tool as it will be after the update is validated, so a change that would leave it unusable (clearing the key of a provider that needs one) is refused rather than stored.

patch/v1/search-tools/{name}

Path parameters

namestring required

Request body

api_basestring nullable
api_keystring nullable

New API key. Omit to keep the existing one. Never returned.

expected_updated_atstring nullable

Optimistic concurrency: if set, the update 412s unless it matches the stored updated_at.

optionsobject nullable
providerstring nullable
timeoutnumber nullable

Response

Successful Response

api_basestring nullable
created_atstring nullable
decryptableboolean
last4string nullable
namestring required
optionsobject
providerstring required
shadows_configboolean

True when a config-file search tool of the same name exists; the stored one is in effect.

timeoutnumber nullable
updated_atstring nullable