Update API key metadata
curl --request PATCH \
--url https://api.signuprisk.com/v1/dashboard/api-keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"clear_expiration": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
scopes: [],
expires_at: '2023-11-07T05:31:56Z',
clear_expiration: true
})
};
fetch('https://api.signuprisk.com/v1/dashboard/api-keys/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.signuprisk.com/v1/dashboard/api-keys/{id}"
payload = {
"name": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"clear_expiration": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.signuprisk.com/v1/dashboard/api-keys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"clear_expiration\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "<string>",
"name": "<string>",
"environment": "live",
"scopes": [
"analyze"
],
"status": "active",
"preview": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"rotated_from_key_id": "<string>"
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}API Keys
Update API key metadata
PATCH
/
v1
/
dashboard
/
api-keys
/
{id}
Update API key metadata
curl --request PATCH \
--url https://api.signuprisk.com/v1/dashboard/api-keys/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"clear_expiration": true
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
scopes: [],
expires_at: '2023-11-07T05:31:56Z',
clear_expiration: true
})
};
fetch('https://api.signuprisk.com/v1/dashboard/api-keys/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.signuprisk.com/v1/dashboard/api-keys/{id}"
payload = {
"name": "<string>",
"scopes": [],
"expires_at": "2023-11-07T05:31:56Z",
"clear_expiration": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.signuprisk.com/v1/dashboard/api-keys/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"scopes\": [],\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"clear_expiration\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "<string>",
"name": "<string>",
"environment": "live",
"scopes": [
"analyze"
],
"status": "active",
"preview": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_used_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"rotated_from_key_id": "<string>"
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}{
"error": {
"code": "MISSING_API_KEY",
"message": "<string>",
"type": "authentication_error",
"request_id": "<string>",
"retryable": true,
"details": {},
"action": {
"type": "upgrade_plan",
"url": "<string>",
"label": "<string>",
"required_plan": "<string>"
},
"field_errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
],
"retry_after_seconds": 123,
"upgrade_required": true,
"required_plan": "<string>",
"recommended_plan": "<string>"
}
}Authorizations
Clerk dashboard session JWT. Used on dashboard, billing, playground, and admin console routes only:
Authorization: Bearer <Clerk session JWT>
These are human-session credentials, not API keys. The dashboard
frontend must never send authoritative account IDs, plan values, quota
counters, Stripe IDs, or API-key actor fields — the server derives
ownership from the session. Admin console routes additionally require
the custom admin_role claim (admin or support) on the same
verified session JWT; writes require admin.
Path Parameters
Body
application/json
Response
Updated key metadata.
Available options:
live, test, dev Available options:
analyze, bulk, webhooks No separate "expired" status. Expiration is derived from expires_at; a key past expires_at is treated as expired by verification.
Available options:
active, revoked Non-secret suffix preview of the key (ellipsis + last 4 chars of the secret).
RFC 3339 timestamp (UTC).