Nodes

One server being added over SSH, with its progress and log.

get/nodes/ssh/enrollments/{enrollment_id}

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/nodes/ssh/enrollments/{enrollment_id}
Auth: HTTP bearer

enrollment_idinteger required

Enrollment ID

The enrollment

agent_modestring nullable

service (systemd unit) or detached (started without a service manager: it does not come back after a reboot).

auth_methodstring required

password, private_key or agent.

created_atstring required

errorstring nullable

Why it failed, and what to do.

finished_atstring nullable

hoststring required

host_key_fingerprintstring required

idinteger required

logstring required

What it did, with the server's output (its last 64 KiB).

namestring required

node_idinteger nullable

pairing_idinteger nullable

The pairing it runs on the server.

ssh_addressstring required

ssh_userstring required

statusstring required

running, succeeded or failed.

stepstring required

What it is doing, or was doing when it stopped.