Restore Campaign State

curl --request POST \
  --url https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": {
    "version": "campaign_v1",
    "epoch": 0,
    "round": 0,
    "board_width": 123,
    "board_height": 123,
    "board_shape": "<string>",
    "cells": {},
    "prompts": {},
    "prompt_history": {},
    "color_prefs": {},
    "perks": {},
    "seeded": [
      "<string>"
    ],
    "frames": [
      {}
    ],
    "events": [
      {}
    ],
    "last_round_at": "<string>",
    "pending_round": {}
  },
  "dry_run": true
}
'

import requests

url = "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state"

payload = {
    "state": {
        "version": "campaign_v1",
        "epoch": 0,
        "round": 0,
        "board_width": 123,
        "board_height": 123,
        "board_shape": "<string>",
        "cells": {},
        "prompts": {},
        "prompt_history": {},
        "color_prefs": {},
        "perks": {},
        "seeded": ["<string>"],
        "frames": [{}],
        "events": [{}],
        "last_round_at": "<string>",
        "pending_round": {}
    },
    "dry_run": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    state: {
      version: 'campaign_v1',
      epoch: 0,
      round: 0,
      board_width: 123,
      board_height: 123,
      board_shape: '<string>',
      cells: {},
      prompts: {},
      prompt_history: {},
      color_prefs: {},
      perks: {},
      seeded: ['<string>'],
      frames: [{}],
      events: [{}],
      last_round_at: '<string>',
      pending_round: {}
    },
    dry_run: true
  })
};

fetch('https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'state' => [
        'version' => 'campaign_v1',
        'epoch' => 0,
        'round' => 0,
        'board_width' => 123,
        'board_height' => 123,
        'board_shape' => '<string>',
        'cells' => [
                
        ],
        'prompts' => [
                
        ],
        'prompt_history' => [
                
        ],
        'color_prefs' => [
                
        ],
        'perks' => [
                
        ],
        'seeded' => [
                '<string>'
        ],
        'frames' => [
                [
                                
                ]
        ],
        'events' => [
                [
                                
                ]
        ],
        'last_round_at' => '<string>',
        'pending_round' => [
                
        ]
    ],
    'dry_run' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state"

	payload := strings.NewReader("{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Restore Campaign State

Install a saved campaign state document wholesale — the undo for a bad write.

Written after a board migration replaced a live league’s cells outright: the hand-authored map_spec s, their rendered previews and the per-cell game_config went with them, and every historical frame’s owners was emptied. Nothing could put a saved copy back a field at a time — cell-map 404s for a cell id the damaged board no longer has, so per-cell restoration cannot even BEGIN until a board of the right shape exists again.

A raw wholesale write does already exist: PUT /v2/leagues/{league_id}/commissioner-state validates a campaign document’s SHAPE and stores it. Shape is the least of what can be wrong with a restore, and this route is that write carrying the guards the incident showed were missing — see _assert_restorable for the refusals, all of which name the disagreement and which side has to move.

THE EPOCH IS NOT RESTORED, IT IS FORCED FORWARD to max(stored, document) + 1. Taking it from the document is the obvious reading and the wrong one, twice. A round that started against the board being replaced persists through runner._write_state, which drops that write only when the epoch has MOVED (fresh.epoch != state.epoch) — so a document whose epoch happens to equal the stored one leaves an in-flight round free to write its whole state, computed against the damaged board, over the restore seconds later. And the epoch namespaces round idempotency keys (campaign:{league}:e{epoch}:{n}), so restoring an earlier epoch would let the coming rounds collide with keys the previous war already spent and adopt its orphans. Forcing it forward costs one field of byte-identity and buys both; the document round-trips exactly otherwise. The residual race is _write_state’s own unlocked re-read, which predates this route.

Dry-run by default, like migrate-board. The dry report is the whole point of running it first: it counts what the restore gives back and what it takes away against what is stored right now.

POST

leagues

{league_id}

campaign

restore-state

Restore Campaign State

curl --request POST \
  --url https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": {
    "version": "campaign_v1",
    "epoch": 0,
    "round": 0,
    "board_width": 123,
    "board_height": 123,
    "board_shape": "<string>",
    "cells": {},
    "prompts": {},
    "prompt_history": {},
    "color_prefs": {},
    "perks": {},
    "seeded": [
      "<string>"
    ],
    "frames": [
      {}
    ],
    "events": [
      {}
    ],
    "last_round_at": "<string>",
    "pending_round": {}
  },
  "dry_run": true
}
'

import requests

url = "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state"

payload = {
    "state": {
        "version": "campaign_v1",
        "epoch": 0,
        "round": 0,
        "board_width": 123,
        "board_height": 123,
        "board_shape": "<string>",
        "cells": {},
        "prompts": {},
        "prompt_history": {},
        "color_prefs": {},
        "perks": {},
        "seeded": ["<string>"],
        "frames": [{}],
        "events": [{}],
        "last_round_at": "<string>",
        "pending_round": {}
    },
    "dry_run": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    state: {
      version: 'campaign_v1',
      epoch: 0,
      round: 0,
      board_width: 123,
      board_height: 123,
      board_shape: '<string>',
      cells: {},
      prompts: {},
      prompt_history: {},
      color_prefs: {},
      perks: {},
      seeded: ['<string>'],
      frames: [{}],
      events: [{}],
      last_round_at: '<string>',
      pending_round: {}
    },
    dry_run: true
  })
};

fetch('https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'state' => [
        'version' => 'campaign_v1',
        'epoch' => 0,
        'round' => 0,
        'board_width' => 123,
        'board_height' => 123,
        'board_shape' => '<string>',
        'cells' => [
                
        ],
        'prompts' => [
                
        ],
        'prompt_history' => [
                
        ],
        'color_prefs' => [
                
        ],
        'perks' => [
                
        ],
        'seeded' => [
                '<string>'
        ],
        'frames' => [
                [
                                
                ]
        ],
        'events' => [
                [
                                
                ]
        ],
        'last_round_at' => '<string>',
        'pending_round' => [
                
        ]
    ],
    'dry_run' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state"

	payload := strings.NewReader("{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://softmax.com/api/observatory/v2/leagues/{league_id}/campaign/restore-state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"state\": {\n    \"version\": \"campaign_v1\",\n    \"epoch\": 0,\n    \"round\": 0,\n    \"board_width\": 123,\n    \"board_height\": 123,\n    \"board_shape\": \"<string>\",\n    \"cells\": {},\n    \"prompts\": {},\n    \"prompt_history\": {},\n    \"color_prefs\": {},\n    \"perks\": {},\n    \"seeded\": [\n      \"<string>\"\n    ],\n    \"frames\": [\n      {}\n    ],\n    \"events\": [\n      {}\n    ],\n    \"last_round_at\": \"<string>\",\n    \"pending_round\": {}\n  },\n  \"dry_run\": true\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer token issued by Softmax

Path Parameters

league_id

string

required

Pattern: ^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

state

CampaignState · object

required

Show child attributes

dry_run

boolean

default:true

Response

Successful Response

The response is of type Response Restore Campaign State V2 Leagues League Id Campaign Restore State Post · object.

Overview

Endpoints

Restore Campaign State

Authorizations

Path Parameters

Body

Response