Servers

Update a server

Partial update. On a server reported by an agent (`automatic: true`), writing `name`, `os` or `manufacturer` is rejected with a 422 rather than silently ignored — those fields belong to the agent. `type`, `location` and `description` stay editable on every server.

Required scope infrastructure:edit

patch/servers/{id}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the server.

Bodyapplication/json

namestring

Host name. Manual servers only.

osstring

Operating system. Manual servers only.

manufacturerstring

Hardware manufacturer. Manual servers only.

typestring

Kind of server.

locationstring

Where the server sits.

descriptionstring

Free-text description of the server.

Response200 · application/json

The updated server record.

idstring<uuid>required

Identifier of the server.

namestringrequired

Host name of the server.

automaticbooleanrequired

Whether the server is reported by an agent rather than declared by hand.

systemstring | null

System family of the server.

osstring | null

Operating system running on the server.

descriptionstring | null

Free-text description of the server.

criticalitystring | null

Business criticality of the server.

modelstring | null

Hardware model.

serialNumberstring | null

Hardware serial number.

manufacturerstring | null

Hardware manufacturer.

typestring | null

Kind of server.

locationstring | null

Where the server sits.

dataCollectionStatusstring | null

State of the agent data collection.

lastCheckTimestring<date-time> | null

Last time the agent reported in.

uptimenumber | null

Seconds since the last boot.

domainstring | null

Domain the server belongs to.

fqdnstring | null

Fully qualified domain name.

cpuobject

Processor of the server.

memorySizenumber | null

Installed memory, in bytes.

disksobject[]

Disks attached to the server.

metricsobject

Latest CPU, load, memory and storage readings.

ownersany[]

Members responsible for the server.

tagsany[]

Tags attached to the server.

linkedApplicationsany[]

Applications hosted on the server.

interfacesany[]

Network interfaces of the server.

customFieldsany[]

Workspace custom fields and their values.