Skip to main content

Subscribe to real-time offering change events.

GET 
/api/v2/events/offering

Opens an SSE stream that fires whenever the device offering catalog is updated. The payload is a Vec<ProjectOfferingDto> — identical in shape to the GET /device/offering REST response — requiring no follow-up HTTP fetch by the consumer.

Use bypass_policy and include_updates query parameters to control the subscription filter. Each SSE event will be computed according to the parameters provided at subscription time.

Request​

Query Parameters

    bypass_policy boolean

    Skip policy enforcement; availability will be null on all releases

    include_updates boolean

    Include releases currently being delivered, deployed, or already installed

    offering_mode OfferingMode

    Possible values: [download, install]

    Offering scope when this device is configured with the universal platform token.

    • install (default): returns only offerings defined for this device's own platform and device types.
    • download: returns all offerings across all platforms and device types in the DB.

Responses​

SSE stream — fires Vec<ProjectOfferingDto> on offering change

Schema

  • Array [

    • applicationCategory stringnullable

    Application category (user or technician)

    displayName stringnullable

    Display name of the project

    label stringnullable

    Label of the project

    projectId int64required

    Identifier of the project

    projectName stringrequired

    Name of the project

    releases object[]required

    All releases offered for this project

    tagline stringnullable

    Short one-line summary of the project

    tags string[]nullable

    Tags of the project

  • ]

Loading...