devtools

Mint a remote control link for one HTML source.

Changed on

The block is the name an operator has for a page, so this is the endpoint a client uses. The link is for the block: a session opens on the page the block renders at that moment, whatever URL it is on and however many other blocks share its URL, and a restarted flow's new page is reached through the same link.

post/api/flows/{flow_id}/blocks/{block_id}/devtools/link

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

flow_idstring required

Flow id

block_idstring required

Block instance id

Response

A remote control link for this HTML source

expires_in_secondsinteger required

How long the link survives without being used. Each use starts it over.

idstring required

A name for this link that is not the credential.

Safe to show, store and log. It is what DELETE /api/devtools/links/{id} takes, so a link can be revoked without anyone having to keep the key.

pathstring required

Path to open in a browser, relative to this Strom instance.

This one is the credential — everything under it is reachable by whoever holds it, so it is handed to a person, never logged or stored.

warningstring required

What the holder of this link can actually reach, in Strom's words: one of [SCREENCAST_CONTROL_WARNING] (with [SHARED_CONTEXT_WARNING] appended when sources share a browser context) or [REMOTE_CONTROL_WARNING]. A client shows it to the operator before handing the link on.

Changes