FugokuFugoku Docs
Mask

Instance Schema

JSON:API schema for Instance resources

Instance Schema

Instances are Fugoku's unified compute resource, covering both virtual machines and bare metal hosts. See Bare Metal Instance Attributes for additional fields returned on bare metal instances.

Attributes

FieldTypeDescription
idstringUnique instance identifier (e.g., inst-abc123)
typestringAlways instances
namestringInstance name (1–64 chars)
statusstringCurrent status
planobjectPlan object with name, slug
operating_systemobjectOS object with name, slug, version
regionobjectRegion object with city, slug
sitestringSite identifier (e.g., lagos-1)
primary_ipv4string?Primary IPv4 address
primary_ipv6string?Primary IPv6 address
providerstring?Provider name
spotbooleanWhether spot pricing is used
tagsobject[]?Key-value tags
created_atstringISO 8601 creation timestamp
updated_atstringISO 8601 update timestamp

Status Values

  • active — Running and available
  • creating — Provisioning
  • pending — Queued for provisioning
  • starting — Booting up
  • stopping — Shutting down
  • stopped — Powered off
  • error — Provisioning or runtime error
  • terminated — Permanently deleted
  • terminating — Deletion in progress
  • reinstalling — OS reinstall in progress
  • rescued — In rescue mode
  • rescuing — Entering rescue mode

Health

Health check, readiness, and process metrics

Provider Schema

JSON:API schema for cloud provider resources

On this page

Instance SchemaAttributesStatus Values