Nodes

Redeploy a node

Redeploy a node by replacing its current VM with a new one. Optionally update the VM image and cloud init user data.

put/v1/nodes/{id}/redeploy

Path parameters

idstring required

Node ID or name

Request body

image_idstring

Redeploy node with this VM image ID

cloud_init_user_datastring byte

Update the cloud init user data for VMs running on this node Data should be base64 encoded

override_emptyboolean

If false, then the new VM will inherit any configuration (like image_id, cloud_init_user_data) that is left empty in this request from the current VM.

If true, then any configuration left empty will be set as empty in the new VM. E.g if cloud_init_user_data is left unset and override_empty is true, then the new VM will not have any cloud init user data. override_empty defaults to false.

Example request

{
  "image_id": "image_1234567890abcdef",
  "cloud_init_user_data": "aGVsbG8gd29ybGQ="
}

Response

Node redeployed successfully

objectstring required
idstring required
namestring required
zonestring nullable
gpu_type'H100' | 'H200' required
ownerstring required
status'pending' | 'awaitingcapacity' | 'running' | 'released' | 'terminated' | 'deleted' | 'failed' | 'unknown' required

Node Status

created_atinteger nullable

Creation time as Unix timestamp in seconds

updated_atinteger nullable

Last updated time as Unix timestamp in seconds

start_atinteger nullable

Start time as Unix timestamp in seconds

end_atinteger nullable

End time as Unix timestamp in seconds

deleted_atinteger nullable

Deletion time as Unix timestamp in seconds

procurement_idstring nullable
max_price_per_node_hourinteger nullable

Max price per hour you're willing to pay for a node in cents

node_type'autoreserved' | 'reserved' required

Example response

{
  "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.1080

  • b819ba3108b3472See 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 404 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 api_error enum value from the error/type response property for the response status 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 422

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-removed

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

      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 404

      response-property-enum-value-added

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

      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 current_vm/oneOf[node-api_Vm]/zone to the response with the 200 status

      response-required-property-added

    • added the required property 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