Skip to documentation
DocumentationAPI referenceGet server resources
GETBearer token

Get server resources

/api/v1/servers/:id/resources

Read server details and current firewall attachments. firewallState distinguishes preview, unsynced and ready; null firewalls is not an empty confirmed attachment list.

Request example

cURL
curl "https://tovahub.com/api/v1/servers/507f1f77bcf86cd799439012/resources" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Parameters

idPath · Required

string

Resource ID: 24 hexadecimal characters. Use the platform ID returned by the matching list endpoint, not a supplier instance ID.

Response

HTTP status 200

Read local server details with the current saved firewall attachment state.

testOnlyboolean

Whether this server is isolated test inventory.

testUntilstring (ISO 8601) | null

Test inventory expiry, if any.

supplierPaidThroughstring (ISO 8601) | null

The server's saved expiresAt value; returned under this historical field name.

instanceIdstring

Supplier instance identifier, not the platform server ObjectId.

namestring

Saved hostname, or an empty string.

statusstring

Saved server status.

previewboolean

Whether the server is a read-only preview.

regionstring

Region label, falling back to its code.

dataCenterstring

Currently an em-dash placeholder.

productstring

Saved product label, falling back to an em dash.

cpunumber

Saved CPU count, or zero.

memoryMbnumber

Saved memory in MB, or zero.

diskMbnumber

Saved disk capacity in MB, or zero.

operatingSystemstring

Saved OS label or identifier, falling back to an em dash.

imageIdnull

Not populated by the current local-details reader.

ipv4string | null

Saved IPv4 address, if any.

ipv6string | null

Saved IPv6 address, if any.

macAddressstring

Saved MAC address, or an empty string.

createdAtstring (ISO 8601) | null

Saved purchase creation time, if any.

additionalIpsnull

Not populated by the current local-details reader.

privateNetworksnull

Not populated by the current local-details reader.

firewallStatestring ('preview' | 'unsynced' | 'ready')

Whether firewall data is available for this server.

firewallsarray | null

Null for preview or unsynced states; otherwise the matching attachments.

firewalls[].idstring

Supplier firewall identifier, not necessarily its local platform identifier.

firewalls[].namestring

Firewall display name.

firewalls[].statusstring

Supplier firewall status.

firewalls[].attachedInstanceCountnumber

Number of visible attached organization servers.

firewalls[].rulesarray

Rules with displayName, protocol, destPorts, ipv4, ipv6, action, and status.