Support API Key Authentication

Rent node

Changed on

Endpoint to rent a node with the provided details. Send an Idempotency-Key header (1-255 letters, digits, -, _, ., :; a UUID is fine) to make a retry safe: within 24 h the same key with the byte-identical body returns the first call's answer — the same pod_id, or the same refusal — with Idempotent-Replayed: true and Idempotency-Original-Request-Id; to retry a refused rent, send a new key. The same key with a different body is refused (422 idempotency_key_reused); a malformed key is 422 idempotency_key_invalid; a repeat while the first call is still running gets 409 idempotency_in_progress with Retry-After: 1. Without the header every call rents.

post/executors/{executor_uuid}/rent

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/executors/{executor_uuid}/rent
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

executor_uuidstring uuid required

Headers

Idempotency-Keystring

Makes a retry safe: within 24 h the same key with the byte-identical body returns the first call's answer with Idempotent-Replayed: true; a different body is 422 idempotency_key_reused; a repeat while the first call runs is 409 idempotency_in_progress; a repeat of a call that may have rented but whose answer was not recorded is 409 idempotency_outcome_unknown, with no expiry.

X-Customer-Refstring

Your tag for the end customer of this one rental; overrides the key's customer_ref.

Request body

pod_namestring required
template_idstring uuid nullable
gpu_countinteger nullable
volume_idstring nullable
backup_log_idstring uuid nullable
restore_pathstring nullable
skip_add_agent_ssh_keyboolean nullable
termination_hoursinteger nullable
initial_port_countinteger nullable
enable_jupyterboolean nullable
enable_volume_encryptionboolean nullable
enable_backupsboolean
dockerfile_contentstring nullable
ncu_profilingboolean

Example request

{
  "backup_log_id": "123e4567-e89b-12d3-a456-426614174000",
  "enable_jupyter": false,
  "initial_port_count": 10,
  "pod_name": "123e4567-e89b-12d3-a456-426614174000",
  "restore_path": "/home/user/data",
  "skip_add_agent_ssh_key": false,
  "template_id": "b21be992-dde1-4aa1-a42f-6787c7af9846",
  "termination_hours": 24,
  "user_public_key": [
    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMo32AY0vFK7g5FBIBcyPdxaxSEM5rEc0kEzMVveA9b+",
    "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIMo32AY0vFK7g5FBIBcyPdxaxSEM5rEc0kEzMVveA9eb+"
  ],
  "volume_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Rent node

unknown required

Changes