SoulFire LogoSoulFire

Update instance config

Replaces the entire instance configuration. Used primarily for profile import operations. For individual setting changes, use UpdateInstanceConfigEntry instead.

PATCH
/v1/instances/{id}/config

Replaces the entire instance configuration. Used primarily for profile import operations. For individual setting changes, use UpdateInstanceConfigEntry instead.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to replace the entire instance configuration. This is typically used for profile import operations. For individual setting changes, use UpdateInstanceConfigEntry instead.

config*

The complete new configuration to replace the existing one. Includes settings, accounts, and proxies.

Response Body

application/json

application/json

application/json

application/json

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

How is this page?