Server Schema

JSON:API schema for bare metal server resources

Server Schema

Attributes

Field	Type	Description
`id`	string	Unique server identifier
`projectId`	string	Project ID
`providerId`	string	Provider ID
`planId`	string	Plan ID
`regionId`	string	Region ID
`operatingSystemId`	string	Operating system ID
`hostname`	string	Server hostname
`label`	string	Display label
`status`	string	Current status
`ipmiStatus`	string	IPMI status
`role`	string	`BareMetal` or `VirtualMachine`
`site`	string	Data center site
`locked`	boolean	Whether server is locked
`rescueAllowed`	boolean	Whether rescue mode is available
`primaryIpv4`	string?	Primary IPv4 address
`primaryIpv6`	string?	Primary IPv6 address
`billing`	string	Billing cycle (`hourly`, `monthly`, `yearly`)
`specs`	object?	Hardware specifications
`tags`	object?	Key-value tags
`interfaces`	object?	Network interfaces
`projectData`	object?	Project-specific metadata
`teamData`	object?	Team-specific metadata
`createdAt`	string	ISO 8601 creation timestamp
`scheduledDeletionAt`	string?	Scheduled deletion timestamp
`updatedAt`	string	ISO 8601 update timestamp

Status Values

active
creating
deleting
error
inactive
installing
maintenance
pending
rescued
rescuing
restarted
scheduled
starting
stopped
stopping
suspended
terminated
updating
waiting

Roles

BareMetal — Dedicated physical server
VirtualMachine — Virtualized instance

Instance Schema

JSON:API schema for Instance resources

Provider Schema

JSON:API schema for cloud provider resources

On this page

Server Schema Attributes Status Values Roles