Nodes

List nodes

List all nodes for the authenticated account

get/v1/nodes

Query parameters

idstring[]

Filter nodes by node_id Use ?id=n_b1dc52505c6db142&id=n_b1dc52505c6db133 to specify multiple IDs. Cannot combine with name or node_type

namestring[]

Filter nodes by their names Use ?name=val1&name=val2 to specify multiple names. Cannot combine with id or node_type

type'autoreserved' | 'reserved'

Filter nodes by their type Cannot combine with id or name

Response

List of nodes

objectstring required

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

  • b819ba3108b3348See the full diff
    • removed the optional property error/details from the response with the 401 status

      response-optional-property-removed

    • removed the optional property error/details from the response with the 403 status

      response-optional-property-removed

    • removed the optional property error/details from the response with the 500 status

      response-optional-property-removed

    • removed the api_error enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the api_error enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the api_error enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the authentication_error enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the authentication_error enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the authentication_error enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the conflict enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the conflict enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the conflict enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the conflict enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the forbidden enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the forbidden enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the forbidden enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the idempotency_error enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the idempotency_error enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the idempotency_error enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the idempotency_error enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the invalid_request_error enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the invalid_request_error enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the invalid_request_error enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the not_found enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the not_found enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the not_found enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the not_found enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the not_implemented enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the not_implemented enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the not_implemented enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the not_implemented enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the payment_required enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the payment_required enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the payment_required enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the payment_required enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the request_timed_out enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the request_timed_out enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the request_timed_out enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the request_timed_out enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the service_unavailable enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the service_unavailable enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the service_unavailable enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the service_unavailable enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the unprocessable_entity enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the unprocessable_entity enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the unprocessable_entity enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the unprocessable_entity enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • removed the upgrade_required enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the upgrade_required enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the upgrade_required enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the upgrade_required enum value from the error/type response property for the response status 500

      response-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_unavailable enum value from the error/type response property for the response status 400

      response-property-enum-value-removed

    • removed the resource_unavailable enum value from the error/type response property for the response status 401

      response-property-enum-value-removed

    • removed the resource_unavailable enum value from the error/type response property for the response status 403

      response-property-enum-value-removed

    • removed the resource_unavailable enum value from the error/type response property for the response status 500

      response-property-enum-value-removed

    • added the new resource_unavailable enum value to the error/type response property for the response status 400

      response-property-enum-value-added

    • added the new resource_unavailable enum value to the error/type response property for the response status 401

      response-property-enum-value-added

    • added the new resource_unavailable enum value to the error/type response property for the response status 403

      response-property-enum-value-added

    • added the new resource_unavailable enum value to the error/type response property for the response status 500

      response-property-enum-value-added

    • added the required property data/items/current_vm/oneOf[node-api_Vm]/zone to the response with the 200 status

      response-required-property-added

    • added the required property data/items/vms/oneOf[node-api_VmList]/data/items/zone to the response with the 200 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog