api-keys

Update an API key's project binding and limits (owner/admin)

patch/v1/orgs/{org_id}/api-keys/{key_id}

Request

  • Base URL: https://api.wavehouse.cloud
  • URL: https://api.wavehouse.cloud/v1/orgs/{org_id}/api-keys/{key_id}
  • Auth: one of:
    • API key in cookie whc_session
    • HTTP bearer

Path parameters

org_idstring required
key_idstring required

Request body

all_projectsboolean

grant the key access to EVERY project in the org; else set project_ids

limitsstring[]

replacement limit set; omit to keep the current one, [] to clear it

project_idsstring[]

replacement project-id allow-list; required unless all_projects=true or only limits change

Response

OK

all_projectsboolean required

true = the key may touch every project in the org

created_atstring date-time required
created_bystring required

user id that created the key

idstring required
key_prefixstring required

the key's first 14 characters (whc_key_ + 6), to tell keys apart

last4string required

the key's last four characters

last_used_atstring date-time

absent until first authenticated use; updated at most once a minute

limitsstring[] required

what the key may not do even where its role could; empty = only its role applies

namestring required
project_idsstring[] required

the project id(s) the key may touch (empty when all_projects)

rolestring required

org role the key acts as (admin | member)

Changes

No recorded changes to this operation across all 1 revision of this API.