Post organisations boards publish

Publish a board at the revision specified by the provided event ID. This is an asynchronous action, callers should await for a BoardPublishedEvent over the websocket API (recommended) or poll GetBoard until publishedEventId matches the event ID which has been provided to publish.

If the request has caused a board to schedule then this request will always return 202.

If this request succeeds but then an error occurs in scheduling, a BoardPublishFailedEvent will be produced over the websocket API; this functionality is not currently available over the REST API.

POST /organisations/{organisationId}/boards/{boardId}/publish

cURL

cURL

curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/boards/{boardId}/publish \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastEventId": "<string>",
  "boardDeployVersion": "<string>"
}
'

202

{
  "ok": true,
  "taskId": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

organisationId · string · required

boardId · string · required

Body

application/json

Payload to trigger a board to be published

lastEventId · string · required

boardDeployVersion · string

The version of the board to deploy. It can be one of v2 for single executor board or v1 for current implementation.

Response

202

application/json

The response after a board has been scheduled to execute.

BoardPublishResult is used to indicate if the publish request has been accepted. The actual scheduling is done in the background and does not indicate the board is ready to accept data.

ok · boolean · required

taskId · string