SoulFire LogoSoulFire

Create instance

Creates a new instance with the given friendly name. The instance starts in STOPPED state with default configuration.

POST
/v1/instances

Creates a new instance with the given friendly name. The instance starts in STOPPED state with default configuration.

Authorization

AuthorizationBearer <token>

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

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

friendlyName*string

A human-readable name for the instance. This will be displayed in the UI and can be changed later via UpdateInstanceMeta.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/instances" \  -H "Content-Type: application/json" \  -d '{    "friendlyName": ""  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

How is this page?

List instances GET

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.

Delete account metadata entry DELETE

Deletes a persistent metadata entry from a Minecraft account.