Skip to main content

Dispatch an orchestration action to one or more CDN-connected devices

POST 
/api/cdn/devices/action

Supported action values and their payload requirements:

  • push — non-empty catalog-ID string; inserts a Push offering for each device.
  • deliveryStart / deliveryStop / deliveryCancel / deliveryDelete — non-empty catalog-ID string; broadcasts the command.
  • deployStart — resolves to a non-empty catalog-ID; honors the payload object's force flag to resume past persisted task-state drift, and its optional action (manifest action to run, default install).
  • deployPause — non-empty catalog-ID; the payload object's optional action selects which running action to pause (default install).
  • discovery / metadataRequest — payload is ignored; broadcasts an empty command.

Request​

Body

required

    action OrchActionrequired

    Possible values: [discovery, push, deliveryStart, deliveryStop, deliveryCancel, deliveryDelete, deployStart, deployPause, metadataRequest]

    Unified orchestration action — the single enum shared by:

    • CdnDeviceActionDto (CDN push API request body), and
    • the managed-command SSE channel (orch_events).

    Discovery is SSE-initiated only; the CDN controller may broadcast it to a device but it is not normally sent via the push API.

    devices string[]required

    Target device IDs.

    payload

    object

    nullable

    The two accepted forms of a catalog-based action payload: a catalog-ID string, or a structured [ActionPayload] object.

    oneOf

    string

Responses​

Action executed; returns the action payload

Loading...