web-recorder

Save a recorded sign-in

Save a completed recording to a web asset, using mediaId and optional secrets. The recorded steps are stored on the asset's web configuration, secrets are encrypted and referenced by name, and the session ends.

Notes.

  • The asset's sign-in is replayed later to refresh its cookies; call links/:mediaId/verify to test it now.
post/v1/web-recorder/{sid}/finalize

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/web-recorder/{sid}/finalize
  • Auth: HTTP bearer

Path parameters

sidstring required

Recording session id, from start.

Request body

mediaIdstring required

The web page asset to save the steps to.

secretsobject

valueRef → secret value. Encrypted; never returned. Null or empty removes one.

removeStepsinteger[]

Indices into the session's steps to leave out of the saved recording.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.