Sign in
General APIs with JWT

Set or clear the key's budgets or end-customer tag

Changed on

{"daily_budget_usd": 25} sets a budget, {"daily_budget_usd": null} clears it; a field the body does not name is left as it is. Signed-in session only, like every key route — a key cannot lift its own budget. Resellers: {"customer_ref": "<tag>"} sets the tag every rental this key opens is recorded under; {"customer_ref": null} clears it. Rentals already recorded keep the tag they were opened under. 1-64 characters, letters, digits and . _ : -; anything else is 422.

patch/keys/{api_key_id}

Request

  • Base URL: https://lium.io/api
  • URL: https://lium.io/api/keys/{api_key_id}
  • Auth: HTTP bearer

Path parameters

api_key_idstring required

Request body

customer_refstring nullable

Your tag for the end customer this key serves (null clears it): 1-64 characters, letters, digits, . _ : -

Response

Successful Response

idstring uuid required
user_idstring uuid required
namestring required
keystring required
is_activeboolean required
created_atstring date-time required
expires_atstring date-time nullable required
last_usedstring date-time nullable required
scopesstring[] required
workspace_idstring uuid nullable required
created_by_user_idstring uuid nullable required
daily_budget_usdnumber nullable required
monthly_budget_usdnumber nullable required
max_budget_usdnumber nullable required
pod_visibilitystring required
customer_refstring nullable required
spent_today_usdnumber required
spent_month_usdnumber required
spent_total_usdnumber required
pods_countinteger required
refused_todayinteger required

Changes