Skip to content

Replace profile configuration

PUT
/api/v1/profiles/{id}

Replaces the profile config JSON for the latest revision and optionally updates raw Nix overrides or schema version.

id
required
string

Profile identifier.

object
config
required

Full replacement config JSON object for the latest profile revision.

object
key
additional properties
any
packages

Optional convenience override for the packages config field.

Array<string>
kernel
object
attr
string
source_override
object
enabled
required
boolean
url
string format: uri
ref
string
rev
string
patches
Array<object>
object
name
required
string
sha256
required
string
content_base64
required
string
openclaw_microvm_enabled
boolean
raw_nix
string
config_schema_version
integer
>= 1
Examples

Replace the full config object

{
"config": {
"packages": [
"vim",
"curl"
],
"kernel": {
"attr": "linux_6_19",
"source_override": {
"enabled": true,
"url": "https://github.com/example/linux.git",
"ref": "refs/heads/main",
"rev": "abcd1234abcd1234abcd1234abcd1234abcd1234"
}
},
"openclaw_microvm_enabled": true,
"custom_banner": "Production profile"
},
"raw_nix": "{ pkgs, ... }: { services.openssh.enable = true; }",
"config_schema_version": 2
}

Updated profile configuration.

object
profile
required
object
id
required

Profile identifier.

string
fleet_id

Primary fleet identifier when one is available.

string
fleet_ids
required

All fleet identifiers assigned to the profile.

Array<string>
fleet_name

Human-readable name of the primary fleet.

string
name
required

Profile name.

string
description

Optional profile description.

string
latest_revision
required

Latest known profile revision.

integer
config_hash

Hash of the latest configuration revision when available.

string
created_at
required

UTC timestamp string returned by the current API implementation.

string
config_schema_version
required

Current configuration schema version for the latest revision.

integer
config
required

Canonical JSON configuration object for the latest profile revision.

object
key
additional properties
any
packages
required

Parsed package list from the profile configuration.

Array<string>
kernel
required
object
attr

Selected kernel attribute.

string
source_override
required
object
enabled
required
boolean
url
string format: uri
ref
string
rev
string
patches
required
Array<object>
object
name
required
string
sha256
required
string
content_base64
required
string
openclaw_microvm_enabled
required

Whether the OpenClaw MicroVM integration is enabled.

boolean
raw_nix

Raw Nix overrides stored with the latest profile revision.

string
created_new_revision
required

Whether the mutation created a new profile revision.

boolean
Examples

Replaced profile config with a new revision

{
"created_new_revision": true,
"profile": {
"id": "a8ce71df-4c80-4d45-919a-bfd474a4d724",
"fleet_id": "fleet-primary",
"fleet_ids": [
"fleet-primary",
"fleet-secondary"
],
"fleet_name": "Primary Fleet, Secondary Fleet",
"name": "Production Base",
"description": "Base image for production devices.",
"latest_revision": 13,
"config_hash": "e6fbc4d0a2d18417d77d1815f6d9f466c52fd208dafeb807dcad1e9c8cdf3cf9",
"config_schema_version": 2,
"created_at": "2026-03-18 12:00:00",
"config": {
"packages": [
"vim",
"curl"
],
"kernel": {
"attr": "linux_6_19",
"source_override": {
"enabled": true,
"url": "https://github.com/example/linux.git",
"ref": "refs/heads/main",
"rev": "abcd1234abcd1234abcd1234abcd1234abcd1234"
}
},
"openclaw_microvm_enabled": true,
"custom_banner": "Production profile"
},
"packages": [
"vim",
"curl"
],
"kernel": {
"attr": "linux_6_19",
"source_override": {
"enabled": true,
"url": "https://github.com/example/linux.git",
"ref": "refs/heads/main",
"rev": "abcd1234abcd1234abcd1234abcd1234abcd1234",
"patches": []
}
},
"openclaw_microvm_enabled": true,
"raw_nix": "{ pkgs, ... }: { services.openssh.enable = true; }"
}
}

Invalid profile mutation request.

object
error
required
string

Missing or invalid API key.

object
error
required
string

The authenticated user can view the profile but cannot modify it.

object
error
required
string

Profile not found or not visible to the authenticated user.

object
error
required
string