---

Publishing a Scene

You can manually publish the scene for use with the new player.

Definition

POST https://clara.io/api/scenes/{uuid}/publish

URL Parameters

• uuid: the scene ID.

Query Parameters

• wait: (default true). When wait is false, this command returns the most recently published version, and if necessary, enqueues a job to update. When wait is true, it waits until the job is complete before returning if the scene is out of date. Use wait=false when it’s more important to display the scene quickly and wait=true when it’s more important to display the latest version of the scene.

Body Parameters

• pin. Request a pin to be set on publish. This will mark the publish with a pin, and will be the new published scene to be returned when the pinned scene is asked for.

Returns

• hash: The hash of the published scene
• version: The player version the scene was published with
• formatVersion: The player format version number the scene was published with
• jobId: The enqueued publish job id. jobId = null indicates that the returned hash is up to date with the scene. Otherwise this jobId indicates the job that is making the publish current. (if wait=true this is always null).

Example Request

curl "https://clara.io/api/scenes/59f6f456-cdb4-4c77-a578-4de894bc53c5/publish" \
    -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b \
    -X POST

curl "https://clara.io/api/scenes/59f6f456-cdb4-4c77-a578-4de894bc53c5/publish?wait=false" \
  -d pin=true
  -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b \
  -X POST

---