Authorizations
Body
application/json
Payload to trigger a board to be published
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>"
}'
{
"ok": true,
"taskId": "<string>"
}
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.
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>"
}'
{
"ok": true,
"taskId": "<string>"
}
Payload to trigger a board to be published