SoulFire LogoSoulFire

Set instance metadata entry

Sets a single persistent metadata entry for the instance. Creates the namespace and key if they don't exist, or updates if they do.

PUT
/v1/instances/:instance_id/metadata/namespaces/:namespace/entries/:key

Sets a single persistent metadata entry for the instance. Creates the namespace and key if they don't exist, or updates if they do.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

instance_id*string

The unique identifier (UUID) of the instance.

Formatuuid
namespace*string

The namespace for the metadata entry.

key*string

The key for the metadata entry within the namespace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

value*

The value to set. Supports JSON value types.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://127.0.0.1:38765/v1/instances/:instance_id/metadata/namespaces/:namespace/entries/:key" \  -H "Content-Type: application/json" \  -d '{    "value": {}  }'
{}

How is this page?

Delete instance metadata entry DELETE

Deletes a persistent metadata entry from the instance.

Get account metadata GET

Gets persistent metadata for a Minecraft account. Persistent metadata survives bot restarts and session changes.