Update instance metadata

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

id*string

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

Formatuuid

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to update instance metadata (name or icon).

friendlyName?string

New human-readable name for the instance.

icon?string

New icon identifier for the instance.

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

{}

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.

Close container POST