resetDemo

POST

/api/v1/demo/reset

const url = 'https://example.com/api/v1/demo/reset';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"scenario":"basic"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/demo/reset \
  --header 'Content-Type: application/json' \
  --data '{ "scenario": "basic" }'

Registered only when TILECAST_ENV is demo. Replaces all data with a scenario and returns once its simulated players have connected. Requires the Owner role and X-CSRF-Token.

Request Body

application/json

object

scenario

string

Allowed values: basic kitchen-sink

Responses

200

Scenario restored, with the new session CSRF token

application/json

object

data

required

object

state

required

object

scenario

required

string

Allowed values: basic kitchen-sink

scenarios

required

Array<string>

seededAt

required

string format: date-time

players

required

Array<object>

object

screenId

required

string format: uuid

screenName

required

string

transport

required

string

Allowed values: heartbeat socket

connected

required

boolean

manifestVersion

required

integer format: int64

manifestFetches

required

integer

commandsHandled

required

integer

lastCommand

string

lastError

string

csrfToken

string

Example

{
  "data": {
    "state": {
      "scenario": "basic",
      "players": [
        {
          "transport": "heartbeat"
        }
      ]
    }
  }
}

403

Owner role or CSRF token missing

422

Unknown scenario