General APIs with JWT

Create Api Key

Changed on

key is the whole key for every kind: the one time a billing key is shown.

post/keys

Request

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

Request body

namestring required
scopesstring[] nullable
customer_refstring nullable

Your tag for the end customer this key serves: 1-64 characters, letters, digits, . _ : -

pod_visibility'own' | 'account' nullable

own: only the pods this key creates exist for it. account: every pod of the account, within the key's scopes. Omitted: the server default.

Response

Successful Response

idstring uuid required
user_idstring uuid required
namestring required
keystring required
key_retrievableboolean 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
key_prefixstring nullable required
masked_keystring required

Changes

  • 17de96e3dd55Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 8d326a331de9Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status