> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ankra.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Replace a saved Logs search (browser session)

> Replaces the whole search: its name and its query, both required, both stored as sent. There is no partial change, so a member left out is refused rather than read as one to clear. A replacement identical to what is stored writes nothing and is not audited; any other is audited on the application with the name, the previous name when it changed, and which of name and query changed, never the query. Requires applications.write.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /org/applications/{application_id}/saved-log-searches/{search_id}
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts. Only the public platform
    status feed (GET /api/v1/status) is served without one. This document is
    published deliberately: it describes the contract only and carries no
    organisation data or credentials. Report security issues to
    security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Playground
    description: >-
      The organisation's playground cluster: order one, read its provisioning
      status, list the orderable sizes, resize it and destroy it.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Cluster Meshes
    description: >-
      Cilium ClusterMeshes that join an organisation's clusters into one
      network: create a mesh, check whether clusters can join, prepare a running
      cluster, and add or remove members.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Proxmox Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on Proxmox VE VMs: the node,
      storage, bridge, template and size catalogs, create and teardown, start
      and stop, node groups, nodes, standalone VMs, upgrades and the bastion.
  - name: HPE Morpheus Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on HPE Morpheus VMs: the
      group, cloud, plan, layout and network catalogs, create and teardown,
      start and stop, node groups, nodes, standalone VMs, upgrades and the
      bastion.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Projects
    description: >-
      Projects group an organisation's clusters, applications, credentials and
      other resources beneath it: list, create, rename and delete them, switch
      the current project, see who reaches one, and move resources between them.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address, and the AI provider keys your own work runs on.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Platform Status
    description: >-
      The public status of the Ankra platform: incidents and maintenance Ankra
      staff publish, as shown on ankra.ai/status.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /org/applications/{application_id}/saved-log-searches/{search_id}:
    put:
      tags:
        - Applications
      summary: Replace a saved Logs search (browser session)
      description: >-
        Replaces the whole search: its name and its query, both required, both
        stored as sent. There is no partial change, so a member left out is
        refused rather than read as one to clear. A replacement identical to
        what is stored writes nothing and is not audited; any other is audited
        on the application with the name, the previous name when it changed, and
        which of name and query changed, never the query. Requires
        applications.write.
      operationId: replace_application_saved_log_search
      parameters:
        - in: path
          name: application_id
          required: true
          schema:
            type: string
            title: Application Id
        - in: path
          name: search_id
          required: true
          schema:
            title: Search Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationSavedLogSearchWrite'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSavedLogSearch'
          description: The search as it is now, with who changed it last
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSavedLogSearchRefusal'
          description: >-
            The name or the query is refused (saved_log_search_name_invalid,
            saved_log_search_query_invalid, content_too_large); nothing was
            changed
        '403':
          description: >-
            The caller lacks applications.write, or the CSRF cookie and header
            are missing or differ
        '404':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/DemoDetailError'
                  - $ref: '#/components/schemas/ApplicationSavedLogSearchRefusal'
          description: >-
            Not found: "Application not found" as on every application route, or
            saved_log_search_not_found when the application has no search with
            that id (never saved, already removed, or another application's).
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationSavedLogSearchRefusal'
          description: >-
            Another search of the application already has a name that reads the
            same (saved_log_search_name_taken); nothing was changed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: >-
            Validation Error: the body is not JSON, name is missing or not a
            string, query is missing or not an object, or the body has a member
            other than name and query
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    ApplicationSavedLogSearchWrite:
      type: object
      additionalProperties: false
      description: >-
        A whole saved search: its name and its query, both required. A
        replacement replaces both; there is no partial change.
      required:
        - name
        - query
      properties:
        name:
          type: string
          description: >-
            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:
          $ref: '#/components/schemas/ApplicationSavedLogSearchQuery'
    ApplicationSavedLogSearch:
      type: object
      additionalProperties: false
      description: >-
        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.
      required:
        - id
        - name
        - query
        - query_state
        - created_by
        - created_at
        - updated_by
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: The search's id.
        name:
          type: string
          minLength: 1
          maxLength: 80
          description: >-
            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.
        query:
          anyOf:
            - $ref: '#/components/schemas/ApplicationSavedLogSearchQuery'
            - type: 'null'
          description: >-
            The query the Logs page searches with; null exactly when query_state
            is unreadable.
        query_state:
          type: string
          enum:
            - readable
            - unreadable
          description: >-
            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.
        created_by:
          $ref: '#/components/schemas/ApplicationSavedLogSearchMember'
        created_at:
          type: string
          format: date-time
          description: When the search was saved, in UTC.
        updated_by:
          $ref: '#/components/schemas/ApplicationSavedLogSearchMember'
        updated_at:
          type: string
          format: date-time
          description: >-
            When the search was last changed, in UTC; created_at when it never
            was.
    ApplicationSavedLogSearchRefusal:
      type: object
      additionalProperties: false
      description: >-
        Why a saved Logs search request was refused: a sentence to show and a
        stable code to branch on. Nothing was written.
      required:
        - detail
        - error_code
      properties:
        detail:
          type: string
          description: One plain sentence saying what was refused and what to do.
        error_code:
          type: string
          enum:
            - saved_log_search_name_invalid
            - saved_log_search_query_invalid
            - saved_log_search_name_taken
            - saved_log_search_limit_reached
            - saved_log_search_not_found
            - content_too_large
          description: The stable code of the refusal.
    DemoDetailError:
      description: >-
        The FastAPI-style detail envelope the demo routes use for
        400/403/404/409/502 responses.
      properties:
        detail:
          type: string
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ApplicationSavedLogSearchQuery:
      type: object
      additionalProperties: false
      description: >-
        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.
      required:
        - text
        - filters
        - span
      properties:
        text:
          type: string
          maxLength: 500
          description: >-
            The words typed into the search, at most 500 characters; empty when
            none were.
        filters:
          type: array
          maxItems: 20
          items:
            $ref: '#/components/schemas/ApplicationSavedLogSearchFilter'
          description: The filters, at most 20; an empty list when there are none.
        span:
          anyOf:
            - $ref: '#/components/schemas/ApplicationSavedLogSearchSpan'
            - type: 'null'
          description: >-
            The time range the search looks at, as the page writes it; null when
            the search keeps the range the page shows when it is used.
    ApplicationSavedLogSearchMember:
      type: object
      additionalProperties: false
      description: Who saved or last changed a saved search.
      required:
        - user_id
        - name
      properties:
        user_id:
          type: string
          format: uuid
          description: The person's user id.
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Their profile name, else their email, while they are an active
            member of the organisation. Null otherwise, or when neither is
            known.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ApplicationSavedLogSearchFilter:
      type: object
      additionalProperties: false
      description: >-
        One filter of a saved search: lines whose field has the value, or with
        not, lines whose field does not.
      required:
        - field
        - value
        - not
      properties:
        field:
          type: string
          minLength: 1
          maxLength: 64
          description: >-
            What the filter looks at, as the page names it (level, version, pod,
            route, status, kind, req): 1 to 64 characters, no control character,
            no space at either end. The platform keeps any such name; the page
            decides which it knows.
        value:
          type: string
          minLength: 1
          maxLength: 500
          description: >-
            The value the field must have, or must not have with not: 1 to 500
            characters.
        not:
          type: boolean
          description: >-
            True when the filter keeps the lines whose field does NOT have the
            value.
    ApplicationSavedLogSearchSpan:
      type: object
      additionalProperties: false
      description: >-
        A time range as the Logs page writes it. A relative range stays relative
        (the last hour is the last hour whenever the search is used); a range of
        two UTC moments stays on those moments. When both ends are relative, or
        both are moments, from comes before to.
      required:
        - from
        - to
      properties:
        from:
          type: string
          maxLength: 40
          description: >-
            Where the range starts: now, or now-<n><unit> with n of 1 to 4
            digits and unit s, m, h or d (relative to the moment the search is
            used), or a UTC moment YYYY-MM-DD HH:MM[:SS] or
            YYYY-MM-DDTHH:MM[:SS] with an optional Z or +HH:MM zone; at most 40
            characters.
        to:
          type: string
          maxLength: 40
          description: >-
            Where the range ends: now, or now-<n><unit> with n of 1 to 4 digits
            and unit s, m, h or d (relative to the moment the search is used),
            or a UTC moment YYYY-MM-DD HH:MM[:SS] or YYYY-MM-DDTHH:MM[:SS] with
            an optional Z or +HH:MM zone; at most 40 characters.
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http
    SessionCookie:
      description: Browser session. Mutations also require X-Ankra-CSRF.
      in: cookie
      name: ankra_session
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.