Skip to main content
PATCH
/
api-keys
/
{id}
Update API Key
curl --request PATCH \
  --url https://api.veryfront.com/api-keys/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "scopes": [
    "<string>"
  ],
  "expires_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "key_prefix": "<string>",
  "scopes": [
    "<string>"
  ],
  "last_used_at": "<string>",
  "expires_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
name
string
Required string length: 1 - 255
​
scopes
string[]
​
expires_at
string<date-time> | null

Response

API key updated successfully

​
id
string<uuid>
required
​
project_id
string<uuid> | null
required
​
user_id
string<uuid>
required
​
name
string
required
​
key_prefix
string
required
​
scopes
string[]
required
​
last_used_at
string | null
required
​
expires_at
string | null
required
​
created_at
string
required
​
updated_at
string
required