SoulFire LogoSoulFire

Update instance metadata

Updates instance metadata (friendly name or icon). Only one field can be updated per request.

PATCH
/v1/instances/:id/meta

Updates instance metadata (friendly name or icon). Only one field can be updated per request.

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.

friendly_name?string

New human-readable name for the instance.

icon?string

New icon identifier for the instance.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://127.0.0.1:38765/v1/instances/:id/meta" \  -H "Content-Type: application/json" \  -d '{}'
{}

How is this page?