Commands for your organization

All commands of the szenera command line. They run with an API key ak_… or an account of your organization. Each table names, per command, the route, the permission required, whether an API key may carry the permission (“Key”), and whether the command changes something. The “Key” column follows the platform’s permission catalog: a permission reserved for accounts is never granted to a key. The command then answers with 403 (exit 4), and you need a profile with password sign-in.

szenera <befehl> --help shows the positional arguments, flags, and examples of every command. The description there is the source of these tables. This page follows the registry of szenera with 136 commands, and all of them are listed here. 21 of them also serve platform operations and partly take a different route there. Those routes, and the commands that serve operations only, are described under Commands for platform operations.

Flags valid everywhere#

A flag carries its value after the equals sign (--limit=20), and --limit 20 does not exist. An unknown flag is an error (exit 1), not a silent hint. List commands page through results with --limit=<anzahl> (1 to 200, up to 100 for filtered lists), --cursor=<marke>, and --all (follow all pages). Commands that wait for an operation accept --timeout=<dauer> (90s, 20m, 2h, or a number in seconds) and some also --interval=<dauer> and --no-wait. Irreversible actions require --yes. Without the flag, the command aborts with exit 1 and says what would happen.

Environment and credential#

Media and folders#

If the same content is already there, the byte stream is skipped on upload: the precheck recognizes it by its sha256 checksum. From 50 MiB on, the stream runs in 8 MiB chunks.

Scenes, versions, and layouts#

The version of a scene appears twice in the response: as the field version in the body and as the header ETag. The command line reads it itself when --version is missing. For scene publish, two refusals mean different things: Scene.PublishValidationFailed (422, exit 7) is a cause to fix, and Scene.PublishBlocked (409, exit 6) means blocking findings that --ignore-issues closes.

Playlists and programs#

Content is passed in short form: schedule:sch_…, scene:scn_…, playlist:pll_…, asset:ast_…, and for the base of a program also pause.

Playback and widgets#

Advertising#

Advertisers, ad campaigns, bookings, and creatives of your own advertising business. Reading works in every package. Creating and approving additionally require the advertisingDirect capability of the package. Without it, the server answers with 403 and Billing.FeatureNotEntitled (exit 4). Ad campaigns of the ad network appear in campaign list as soon as they reach displays of your organization, without price and without the operator’s note.

A creative is rejected in the portal, where the note for the advertiser is written. Which displays a booking reaches, and why others are not reached, is answered by GET /v1/advertising/booking-lines/{id}/reach through the escape hatch szenera api get.

Devices#

Searching by serial number, releasing and blocking a device, and looking up a single command are commands of platform operations and not part of szenera. See Commands for platform operations.

To re-pair a device, reset it to factory state, remove it from the organization, or report it as lost, there is no command of its own under an organization profile. Use the Lifecycle card in the portal, or api post against POST /v1/devices/{id}/release with {"reason":"reconnect"}, "factory", or "removed", or against POST /v1/devices/{id}/block with a reason (identity.device.lifecycle, not key-capable). If a paired device reports in with a new key, POST /v1/devices/{id}/reregistration decides, with {"decision":"keep"}, "reconnect", or {"decision":"block","reason":"…"}. There is no remote maintenance command for a factory reset.

Locations#

A location is a folder for displays: it carries no permissions and no inventory of its own, and deleting it never takes a display with it. The fields and error codes are under Locations.

Analytics#

Without --from and --to, the last seven days up to yesterday apply. Without a window, an ad campaign shows its run up to yesterday. The table gives hours instead of seconds and percent instead of share, and next to a value stands its upper bound as long as open gaps can still be reported late. Which metric can be calculated with which dimension is shown by szenera api get /v1/analytics/catalog.

Proofs#

With the number and check code from proof show, anyone can verify a proof on the verification page, even without an account. Interim statements and links for advertisers are created in the portal or through the API.

Event targets#

A target that was switched off by hand is under --status=disabled and is something different. Targets are created and changed in the portal or through the API. See Create a webhook endpoint.

Team, roles, and grants#

Keys#

A key can never do more than its issuer, and it can never carry a permission that is not allowed for keys. The CLI checks the second condition before the call.

Package, invoices, and apps#

Log, permission catalog, and escape hatch#

api … is the escape hatch to every route that has no command of its own. The path begins with a slash and may carry a query. The body is JSON directly or @datei.json. This way also goes through the generated client, so headers, trace ID, and error kinds apply as everywhere, but it does not check the response against a contract: no one knows which schema belongs to a freely typed path.

szenera api get "/v1/devices?limit=5" --json | jq -r '.items[].id'
szenera api post /v1/playlists @playlist.json --idempotency-key=import-2026-09-08-01

Related#

• Commands for platform operations
• JSON output and exit codes
• The areas of the reference