---
layout: default
navsection: api
navmenu: API Methods
title: "nodes"

...

See "REST methods for working with Arvados resources":{{site.baseurl}}/api/methods.html

API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/nodes@

UUID type: @7ekkf@

Required arguments are displayed in %{background:#ccffcc}green%.

h2. Resource

Each Node has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:

table(table table-bordered table-condensed).
|_. Attribute|_. Type|_. Description|_. Example|
|slot_number|integer|||
|hostname|string|||
|domain|string|||
|ip_address|string|||
|job_uuid|string|The UUID of the job that this node is assigned to work on.  If you do not have permission to read the job, this will be null.||
|first_ping_at|datetime|||
|last_ping_at|datetime|||
|info|hash|||

h2. Methods

h3. create

Create a new Node.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|node|object||query||

h3. delete

Delete an existing Node.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||

h3. get

Gets a Node's metadata by UUID.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||

h3. list

List nodes.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
|limit|integer (default 100)|Maximum number of nodes to return.|query||
|order|string|Order in which to return matching nodes.|query||
|filters|array|Conditions for filtering nodes.|query||

h3. ping

ping nodes

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|ping_secret|string||query||
{background:#ccffcc}.|uuid|string||path||

h3. update

Update attributes of an existing Node.

Arguments:

table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |_. Example |
{background:#ccffcc}.|uuid|string|The UUID of the Node in question.|path||
|node|object||query||

To remove a node's job assignment, update the node object's @job_uuid@ to null.