> ## 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.

# Update an application alert (browser session)

> Replaces the name, environment, condition and places to send to of an alert the application's own routes made; severity is kept when left out, and what the evaluator recorded on the rule is kept. An organisation alert, or another application's, answers 409. Requires alerts.manage, or applications.write on the application; a viewer is refused whatever the RBAC rollout mode. Audited.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json put /org/applications/{application_id}/alerts/{alert_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, and no operation 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: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /org/applications/{application_id}/alerts/{alert_id}:
    put:
      tags:
        - Alerts
      summary: Update an application alert (browser session)
      description: >-
        Replaces the name, environment, condition and places to send to of an
        alert the application's own routes made; severity is kept when left out,
        and what the evaluator recorded on the rule is kept. An organisation
        alert, or another application's, answers 409. Requires alerts.manage, or
        applications.write on the application; a viewer is refused whatever the
        RBAC rollout mode. Audited.
      operationId: update_application_alert
      parameters:
        - name: application_id
          in: path
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: alert_id
          required: true
          schema:
            format: uuid
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationAlertRequest'
      responses:
        '200':
          description: The updated alert
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAlert'
        '401':
          description: Unauthorized
        '403':
          description: The caller lacks the permission (permission_denied, naming it)
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/SecurityPermissionDenied'
                  - $ref: '#/components/schemas/DemoDetailError'
        '404':
          description: Not found ("Application not found", "Alert not found")
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
        '409':
          description: >-
            The alert is an organisation alert or another application's: change
            it under Alerts, or another alert has the composed name
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DemoDetailError'
        '422':
          description: >-
            A field of the body is wrong (detail names it), or a path parameter
            is not a uuid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationAlertRefusal'
        '500':
          description: Internal server error
      security:
        - SessionCookie: []
      servers:
        - url: https://api.platform.ankra.app
components:
  schemas:
    ApplicationAlertRequest:
      type: object
      title: ApplicationAlertRequest
      description: >-
        A create or a full update of one application alert. No other key is
        accepted.
      additionalProperties: false
      required:
        - name
        - environment_id
        - condition
        - send_to
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
          description: >-
            The alert's name on the application page. Under Alerts the alert is
            named "Application · Environment · name".
        environment_id:
          type: string
          format: uuid
          description: One of the application's environments.
        condition:
          $ref: '#/components/schemas/ApplicationAlertCondition'
        send_to:
          type: array
          minItems: 1
          maxItems: 5
          uniqueItems: true
          items:
            format: uuid
            type: string
          description: >-
            The ids of the organisation's places to send alerts to (its alert
            integrations). They are linked, never changed.
        severity:
          type: string
          enum:
            - critical
            - warning
            - info
          description: >-
            warning when a create leaves it out; an update that leaves it out
            keeps the stored one.
    ApplicationAlert:
      type: object
      title: ApplicationAlert
      description: >-
        One alert of an application's list: an own alert, which these routes
        made and may change, or an organisation alert rule that watches the
        environment, which is changed under Alerts.
      required:
        - alert_id
        - rule_id
        - name
        - own
        - environment_id
        - says
        - condition
        - severity
        - send_to
        - enabled
        - last_firing
        - evaluated_at
        - evaluation
        - unknown_reason
      properties:
        alert_id:
          format: uuid
          type: string
        rule_id:
          format: uuid
          type: string
        name:
          type: string
          description: >-
            The name the person gave an own alert; the alert's name for any
            other.
        own:
          type: boolean
        environment_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The environment an application alert watches; null for an
            organisation rule.
        says:
          type: string
          description: >-
            An own alert's condition in one sentence; the rule's name for any
            other.
        condition:
          anyOf:
            - $ref: '#/components/schemas/ApplicationAlertCondition'
            - type: 'null'
        severity:
          type: string
        send_to:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationAlertDestination'
        enabled:
          type: boolean
          description: True when the alert and its rule are both on.
        last_firing:
          anyOf:
            - $ref: '#/components/schemas/ApplicationAlertFiring'
            - type: 'null'
        evaluated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the evaluator last evaluated the rule; null before its first
            run and while a held rule never was evaluated.
        evaluation:
          type: string
          enum:
            - ok
            - unknown
            - not_evaluated
          description: >-
            ok: the rule was read on its last run. unknown: the evaluator holds
            it unread (the metric store did not answer or lacks the metric, or
            the environment's installations cannot be resolved). not_evaluated:
            no run recorded a state yet.
        unknown_reason:
          type:
            - string
            - 'null'
          description: >-
            Why the evaluator holds the rule, only while evaluation is unknown.
            no_installations: nothing of the application runs on the
            environment, or only on a stopped cluster. application_not_found or
            environment_not_found: what the alert watched is gone; the evaluator
            then closes the alert's open firing with a resolution_note, since
            nothing can report it resolved. Any other value names a read that
            failed or a metric the store lacks.
    SecurityPermissionDenied:
      properties:
        detail:
          enum:
            - permission_denied
          type: string
        permission:
          type: string
        scope_type:
          type: string
      required:
        - detail
        - permission
        - scope_type
      type: object
    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
    ApplicationAlertRefusal:
      type: object
      title: ApplicationAlertRefusal
      description: >-
        A refused application alert request. A field the body got wrong is one
        sentence naming it; a malformed path or query parameter is the
        validation list.
      required:
        - detail
      properties:
        detail:
          oneOf:
            - type: string
            - type: array
              items:
                $ref: '#/components/schemas/ValidationError'
    ApplicationAlertCondition:
      type: object
      title: ApplicationAlertCondition
      description: >-
        The one condition an application alert has: it fires when the metric
        reads above threshold for hold_minutes in a row. The metrics are the
        ones the application's charts draw for the environment.
      additionalProperties: false
      required:
        - condition_type
        - metric
        - threshold
        - hold_minutes
      properties:
        condition_type:
          type: string
          enum:
            - app_metric
        metric:
          type: string
          enum:
            - failed_share_pct
            - p95_ms
            - restarts
          description: >-
            failed_share_pct: the share of requests that failed, in percent.
            p95_ms: the 95th percentile response time, in milliseconds.
            restarts: container restarts in the last 15 minutes.
        route:
          type: 'null'
          description: >-
            Left out or null: an alert on one route is not offered yet, and any
            other value is refused.
        operator:
          type: string
          enum:
            - gt
          default: gt
          description: Left out or null reads as gt.
        threshold:
          type: number
          minimum: 0
          description: At most 100 for failed_share_pct.
        hold_minutes:
          type: integer
          minimum: 1
          maximum: 60
          description: >-
            How many minutes the reading stays above the threshold before the
            alert fires.
    ApplicationAlertDestination:
      type: object
      title: ApplicationAlertDestination
      description: A place an alert sends to.
      required:
        - integration_id
        - type
        - label
      properties:
        integration_id:
          format: uuid
          type: string
        type:
          type: string
          description: >-
            The integration type as stored: slack, teams, discord, pagerduty,
            webhook, ...
        label:
          type: string
          description: The integration's name.
    ApplicationAlertFiring:
      type: object
      title: ApplicationAlertFiring
      description: >-
        An alert's last firing the caller may read. An organisation rule's is
        its last on one of the environment's clusters.
      required:
        - trigger_id
        - triggered_at
        - resolved_at
        - acknowledged_by
        - acknowledged_after_seconds
        - resolved_by
        - resolution_note
      properties:
        trigger_id:
          format: uuid
          type: string
        triggered_at:
          type: string
          format: date-time
        resolved_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Null while the firing is open.
        acknowledged_by:
          anyOf:
            - $ref: '#/components/schemas/ApplicationAlertAcknowledger'
            - type: 'null'
        acknowledged_after_seconds:
          type:
            - integer
            - 'null'
          minimum: 0
          description: >-
            Seconds from the firing to its first acknowledgement, null when
            nobody acknowledged it.
        resolved_by:
          type:
            - string
            - 'null'
          enum:
            - itself
            - person
            - null
          description: >-
            itself when the condition cleared, person when someone resolved it,
            null while it is open or when it ended another way (with its
            incident, or a close that is not a recovery).
        resolution_note:
          type:
            - string
            - 'null'
          description: >-
            Why the firing ended, in plain words, when nothing reported that it
            cleared: the application or the environment it watched is no longer
            there, its source stopped sending it, or its cluster moved to
            another organisation. Null while the firing is open and when it
            ended any other way, so null never means it recovered: resolved_by
            says that.
    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
    ApplicationAlertAcknowledger:
      type: object
      title: ApplicationAlertAcknowledger
      description: Who acknowledged a firing first.
      required:
        - user_id
        - name
      properties:
        user_id:
          type:
            - string
            - 'null'
          description: Null for an acknowledgement recorded before the user id was kept.
        name:
          type:
            - string
            - 'null'
  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.