delete_saved_search

Delete a saved search by id.

delete_saved_search

Delete a saved search by id.

Safety class: C · API type: portal · Min version:

📘

Confinement

Class C: this is the teardown for a created saved search - always delete saved searches you create (cleanup registry). Non-prod only.

Signatures

def delete_saved_search(sdk, saved_search_id):
    """Delete a saved search by id; returns None."""
    return sdk.delete_saved_search(saved_search_id)
export async function deleteSavedSearch(sdk, savedSearchId) {
    // Delete a saved search by id.
    return await sdk.deleteSavedSearch(savedSearchId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
saved_search_idsavedSearchIdstryese.g. <saved-search-uuid>

Returns

None — no body on success.

Errors

  • 401 unauthenticated
  • InvalidAPITypeException on a non-portal session
  • 404 not found

See also: Python ↔ JS naming map · Return shapes.