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
/serversAuthorizations
AuthorizationstringrequiredAuthorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.
Bodyapplication/json
namestringrequiredHost name of the server.
osstringrequiredOperating system running on the server.
ipAddressstringrequiredPrimary IP address of the server.
manufacturerstringHardware manufacturer.
typestringKind of server.
locationstringWhere the server sits.
descriptionstringFree-text description of the server.
Response201 · application/json
The server was created.
idstring<uuid>requiredIdentifier of the server.
namestringrequiredHost name of the server.
automaticbooleanrequiredWhether the server is reported by an agent rather than declared by hand.
systemstring | nullSystem family of the server.
osstring | nullOperating system running on the server.
descriptionstring | nullFree-text description of the server.
criticalitystring | nullBusiness criticality of the server.
modelstring | nullHardware model.
serialNumberstring | nullHardware serial number.
manufacturerstring | nullHardware manufacturer.
typestring | nullKind of server.
locationstring | nullWhere the server sits.
dataCollectionStatusstring | nullState of the agent data collection.
lastCheckTimestring<date-time> | nullLast time the agent reported in.
uptimenumber | nullSeconds since the last boot.
domainstring | nullDomain the server belongs to.
fqdnstring | nullFully qualified domain name.
cpuobjectProcessor of the server.
memorySizenumber | nullInstalled memory, in bytes.
disksobject[]Disks attached to the server.
metricsobjectLatest 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.