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

# List canonical events for an OTA deployment.



## OpenAPI

````yaml /api-reference/ilyama.v1.json get /projects/{project_id}/ota/releases/{release_id}/deployments/{deployment_id}/events
openapi: 3.1.0
info:
  description: >
    Generation-ready starter contract for ilyama's HTTP API.

    This is intentionally scoped to stable routes already mounted in
    services/apis

    so frontend clients can begin integrating against the rewrite immediately.
  title: ilyama Core API
  version: 0.1.0
servers:
  - url: /core/api/v1
security:
  - bearerAuth: []
tags:
  - name: Certificates (HTTP)
  - name: Device JITR
  - name: Device RPC
  - name: Devices
  - name: Edge replication
  - name: Fleets
  - name: Integrations
  - name: MDM
  - name: Notification Event Registry
  - name: Notifications
  - name: OTA
  - name: Observability & data
  - name: Organizations
  - name: Project settings
  - name: Projects
  - name: Projects — Email Templates
  - name: Projects — Notification Subscriptions
  - name: Projects — Status
  - name: System
  - name: Tickets & workflows
  - name: Webhooks
paths:
  /projects/{project_id}/ota/releases/{release_id}/deployments/{deployment_id}/events:
    get:
      tags:
        - OTA
      summary: List canonical events for an OTA deployment.
      operationId: getDeploymentEvents
      parameters:
        - in: path
          name: project_id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: release_id
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: deployment_id
          required: true
          schema:
            format: uuid
            type: string
        - in: query
          name: limit
          schema:
            type: integer
        - in: query
          name: cursor
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CanonicalEventPageResponse'
          description: Deployment event feed
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: TSDB unavailable
      security:
        - bearerAuth: []
          orgIdHeader: []
components:
  schemas:
    CanonicalEventPageResponse:
      properties:
        data:
          properties:
            items:
              items:
                $ref: '#/components/schemas/CanonicalEventItem'
              type: array
          required:
            - items
          type: object
        meta:
          $ref: '#/components/schemas/CursorPaginationMeta'
        ok:
          enum:
            - 1
          type: integer
      required:
        - ok
        - data
        - meta
      type: object
    ErrorEnvelope:
      properties:
        detail:
          type: string
        message:
          oneOf:
            - type: string
            - type: object
        ok:
          enum:
            - 0
          type: integer
      required:
        - ok
        - message
        - detail
      type: object
    CanonicalEventItem:
      properties:
        action:
          type: string
        correlation_id:
          format: uuid
          nullable: true
          type: string
        device_id:
          format: uuid
          nullable: true
          type: string
        domain:
          type: string
        entity:
          type: string
        fleet_id:
          format: uuid
          nullable: true
          type: string
        id:
          format: uuid
          type: string
        occurred_at:
          format: date-time
          type: string
        org_id:
          format: uuid
          type: string
        payload:
          additionalProperties: true
          nullable: true
          type: object
        project_id:
          format: uuid
          type: string
        source_service:
          nullable: true
          type: string
        span_id:
          nullable: true
          type: string
        trace_id:
          nullable: true
          type: string
      required:
        - id
        - org_id
        - project_id
        - domain
        - entity
        - action
        - occurred_at
      type: object
    CursorPaginationMeta:
      description: >-
        Cursor (keyset) pagination metadata for append-only or time-ordered
        feeds.
      properties:
        count:
          description: Number of rows returned in this page (not total across the feed).
          type: integer
        has_more:
          description: >-
            True when another page exists; use meta.next_cursor as the cursor
            query param.
          type: boolean
        items_per_page:
          description: Requested page size (limit query param after clamping).
          type: integer
        next_cursor:
          description: Opaque cursor for the next page; null when has_more is false.
          nullable: true
          type: string
      required:
        - items_per_page
        - count
        - has_more
        - next_cursor
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http
    orgIdHeader:
      in: header
      name: ORG-ID
      type: apiKey

````