Servers

Create a server

Declare a server by hand. Servers created this way have `automatic: false` and stay fully editable, unlike those reported by an agent.

Required scope infrastructure:add

post/servers

Authorizations

Authorizationstringrequired

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

Bodyapplication/json

namestringrequired

Host name of the server.

osstringrequired

Operating system running on the server.

ipAddressstringrequired

Primary IP address of the server.

manufacturerstring

Hardware manufacturer.

typestring

Kind of server.

locationstring

Where the server sits.

descriptionstring

Free-text description of the server.

Response201 · application/json

The server was created.

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.