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

# Preview Notification Routes Endpoint



## OpenAPI

````yaml https://platform.ankra.app/openapi.json post /api/v1/org/notifications/routes/preview
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Kubernetes
    description: Read and act on the Kubernetes objects inside a 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: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: OVH Credentials
    description: OVH credentials and SSH keys.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - 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.
paths:
  /api/v1/org/notifications/routes/preview:
    post:
      tags:
        - Notifications
      summary: Preview Notification Routes Endpoint
      operationId: >-
        preview_notification_routes_endpoint_api_v1_org_notifications_routes_preview_post
      parameters:
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
        - in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Ankra-Organisation-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationRoutePreviewBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationRoutePreview'
          description: Successful Response
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
components:
  schemas:
    NotificationRoutePreviewBody:
      properties:
        kind:
          type: string
          title: Kind
        severity:
          type: string
          title: Severity
        cluster_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          title: Cluster Id
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        alert_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          title: Alert Id
      required:
        - kind
        - severity
      title: NotificationRoutePreviewBody
      type: object
    NotificationRoutePreview:
      properties:
        kind:
          type: string
          title: Kind
        severity:
          type: string
          title: Severity
        cluster_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          title: Cluster Id
        source_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Id
        alert_id:
          anyOf:
            - format: uuid4
              type: string
            - type: 'null'
          title: Alert Id
        routable:
          title: Routable
          type: boolean
        routable_reason:
          title: Routable Reason
          type: string
        deliveries:
          items:
            $ref: '#/components/schemas/NotificationRoutePreviewDelivery'
          title: Deliveries
          type: array
        suppressed:
          items:
            $ref: '#/components/schemas/NotificationRoutePreviewDelivery'
          title: Suppressed
          type: array
        route_evaluations:
          items:
            $ref: '#/components/schemas/NotificationRoutePreviewEvaluation'
          title: Route Evaluations
          type: array
        home_destination_used:
          title: Home Destination Used
          type: boolean
      required:
        - kind
        - severity
        - cluster_id
        - source_id
        - alert_id
        - routable
        - routable_reason
        - deliveries
        - suppressed
        - route_evaluations
        - home_destination_used
      title: NotificationRoutePreview
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    NotificationRoutePreviewDelivery:
      properties:
        destination_id:
          format: uuid4
          title: Destination Id
          type: string
        destination_name:
          title: Destination Name
          type: string
        via:
          title: Via
          type: string
        route_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Route Id
        reason:
          title: Reason
          type: string
      required:
        - destination_id
        - destination_name
        - via
        - route_id
        - reason
      title: NotificationRoutePreviewDelivery
      type: object
    NotificationRoutePreviewEvaluation:
      properties:
        route_id:
          title: Route Id
          type: string
        destination_id:
          title: Destination Id
          type: string
        priority:
          title: Priority
          type: integer
        mode:
          title: Mode
          type: string
        stop_on_match:
          title: Stop On Match
          type: boolean
        matched:
          title: Matched
          type: boolean
        outcome:
          title: Outcome
          type: string
        reason:
          title: Reason
          type: string
      required:
        - route_id
        - destination_id
        - priority
        - mode
        - stop_on_match
        - matched
        - outcome
        - reason
      title: NotificationRoutePreviewEvaluation
      type: object
    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

````