SoulFire LogoSoulFire

Restart bots

Forces the selected bots to establish fresh connections.

POST
/v1/instances/{instance_id}/bots:restart

Forces the selected bots to establish fresh connections.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Path Parameters

instance_id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Reconnects a batch of bots and leaves their desired state set to running.

botIds*array<string>
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/bots:restart" \  -H "Content-Type: application/json" \  -d '{    "botIds": [      "string"    ]  }'
{  "bots": [    {      "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a",      "desiredState": "BOT_DESIRED_STATE_UNSPECIFIED",      "runtimeState": "BOT_RUNTIME_STATE_UNSPECIFIED",      "lastError": "string",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

How is this page?

Reset movement POST

Resets all movement to stopped state. Equivalent to releasing all movement keys. The action is queued and executed on the next game tick.

Set bot desired state POST

Persists whether the selected bots should be running or stopped. The request returns after the desired state is durable. Connections are reconciled asynchronously and can be observed through WatchBotStatuses.