SoulFire LogoSoulFire

Update instance config entry

Updates a single configuration entry by namespace and key. More efficient than UpdateInstanceConfig for individual changes.

PUT
/v1/instances/{id}/config/namespaces/{namespace}/entries/{key}

Updates a single configuration entry by namespace and key. More efficient than UpdateInstanceConfig for individual changes.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

The unique identifier (UUID) of the instance to update.

Formatuuid
namespace*string

The namespace of the setting (e.g., "bot", "account", plugin ID).

key*string

The key of the setting within the namespace.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update a single configuration entry. This is the preferred method for individual setting changes as it is more efficient than replacing the entire configuration.

value*unknown

The new value for the setting. Supports JSON value types (string, number, boolean, null, array, object).

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/config/namespaces/string/entries/string" \  -H "Content-Type: application/json" \  -d '{    "value": null  }'
{}

How is this page?