List nodes
List all nodes for the authenticated account
Query parameters
Filter nodes by node_id Use ?id=n_b1dc52505c6db142&id=n_b1dc52505c6db133 to specify multiple IDs. Cannot combine with name or node_type
Filter nodes by their names Use ?name=val1&name=val2 to specify multiple names. Cannot combine with id or node_type
Filter nodes by their type Cannot combine with id or name
Response
List of nodes
Example response
{
"object": "list",
"data": [
{
"object": "node",
"id": "n_b1dc52505c6db142",
"name": "cuda-crunch",
"zone": "hayesvalley",
"owner": "sfcompute",
"created_at": 1640995200,
"updated_at": 1640995200,
"start_at": 1640995200,
"end_at": 1640995200,
"deleted_at": 1640995200,
"procurement_id": "proc_b1dc52505c6de142",
"max_price_per_node_hour": 1000,
"vms": {
"object": "list",
"data": [
{
"object": "vm",
"id": "vm_myOZZXw4pfcp7H9DQOldd",
"created_at": 1640995200,
"updated_at": 1640995200,
"start_at": 1640995200,
"end_at": 1640998200,
"image_id": "image_myOZZXw4pfcp7H9DQOldd",
"zone": "hayesvalley"
}
]
},
"current_vm": {
"object": "vm",
"id": "vm_myOZZXw4pfcp7H9DQOldd",
"created_at": 1640995200,
"updated_at": 1640995200,
"start_at": 1640995200,
"end_at": 1640998200,
"image_id": "image_myOZZXw4pfcp7H9DQOldd",
"zone": "hayesvalley"
}
}
]
}Changes
Changed in 4 of the 44 revisions of this API.754
- ●
removed the optional property
error/detailsfrom the response with the401statusresponse-optional-property-removed
- ●
removed the optional property
error/detailsfrom the response with the403statusresponse-optional-property-removed
- ●
removed the optional property
error/detailsfrom the response with the500statusresponse-optional-property-removed
- ○
removed the
api_errorenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
api_errorenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
api_errorenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
authentication_errorenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
authentication_errorenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
authentication_errorenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
conflictenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
conflictenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
conflictenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
conflictenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
forbiddenenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
forbiddenenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
forbiddenenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
idempotency_errorenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
idempotency_errorenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
idempotency_errorenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
idempotency_errorenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
invalid_request_errorenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
invalid_request_errorenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
invalid_request_errorenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
not_foundenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
not_foundenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
not_foundenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
not_foundenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
not_implementedenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
not_implementedenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
not_implementedenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
not_implementedenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
payment_requiredenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
payment_requiredenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
payment_requiredenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
payment_requiredenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
request_timed_outenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
request_timed_outenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
request_timed_outenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
request_timed_outenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
service_unavailableenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
service_unavailableenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
service_unavailableenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
service_unavailableenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
unprocessable_entityenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
unprocessable_entityenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
unprocessable_entityenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
unprocessable_entityenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
removed the
upgrade_requiredenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
upgrade_requiredenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
upgrade_requiredenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
upgrade_requiredenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
This revision also has 20 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
removed the
resource_unavailableenum value from theerror/typeresponse property for the response status400response-property-enum-value-removed
- ○
removed the
resource_unavailableenum value from theerror/typeresponse property for the response status401response-property-enum-value-removed
- ○
removed the
resource_unavailableenum value from theerror/typeresponse property for the response status403response-property-enum-value-removed
- ○
removed the
resource_unavailableenum value from theerror/typeresponse property for the response status500response-property-enum-value-removed
- ○
- ●
added the new
resource_unavailableenum value to theerror/typeresponse property for the response status400response-property-enum-value-added
- ●
added the new
resource_unavailableenum value to theerror/typeresponse property for the response status401response-property-enum-value-added
- ●
added the new
resource_unavailableenum value to theerror/typeresponse property for the response status403response-property-enum-value-added
- ●
added the new
resource_unavailableenum value to theerror/typeresponse property for the response status500response-property-enum-value-added
- ●
- ○
added the required property
data/items/current_vm/oneOf[node-api_Vm]/zoneto the response with the200statusresponse-required-property-added
- ○
added the required property
data/items/vms/oneOf[node-api_VmList]/data/items/zoneto the response with the200statusresponse-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○