Skip to content
General Augment Docs

Update Api Key

PATCH
/api/v1/keys/{key_id}

Update API key metadata without ever returning the raw key.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
key_id
required
Key Id
string format: uuid

Header Parameters

Section titled “Header Parameters ”
X-Admin-Key
Any of:
string
X-Admin-API-Key
Any of:
string

Request Body required

Section titled “Request Body required ”
ApiKeyUpdate

Payload for updating non-secret admin API key metadata.

object
expires_at
Any of:
string format: date-time
name
Any of:
string
>= 1 characters <= 100 characters
scopes
Any of:
Array<string>
<= 50 items

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

ApiKeyListItem

Masked admin API key list item.

object
created_at
required
Created At
string format: date-time
created_by
required
Any of:
string
expires_at
required
Any of:
string format: date-time
id
required
Id
string format: uuid
last_used_at
required
Any of:
string format: date-time
masked_key
required
Masked Key
string
name
required
Name
string
project_id
required
Any of:
string format: uuid
scopes
Scopes
Array<string>

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string