API/Responses

Responses

Node reads and lifecycle operations return the same node object. List responses wrap objects in nodes; creation wraps the node alongside credentials.

Node response fields

FieldTypeDescription
idstringNodana node ID
namestringDisplay name
statusstringNode lifecycle state
endpointUrlstringPhoenixd HTTPS endpoint
failureMessagestring or nullPublic failure message
updateStatusstring or nullUpdate progress or outcome
updateCompletedAtinteger or nullUpdate completion time in Unix seconds
createdAtintegerCreation time in Unix seconds
updatedAtintegerLast change time in Unix seconds

Node states

Node states include provisioning, ready, stopped, cordoned, updating, failed, deleting, and deleted. stopped means the user took the node offline; cordoned means it was suspended because the account ran out of credit.

For shared response handling, see Error handling and Rate limiting.

On this page