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.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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 '{}'
{}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?

Update instance config entry PUT

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

Verify email code POST

Verifies an email verification code to complete authentication. The auth_flow_token must match a pending login flow, and the code must match the one that was sent to the user's email. On success, returns a JWT token. On failure, returns a Failure response with INVALID_CODE reason. After successful verification, the auth_flow_token is invalidated and cannot be reused.