Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
One change · api

Update API Key changedapi/admin/api_keys/update

Nearest release: v2.1.250, published an hour before this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.

Recorded here
Lines+58added
Lines−12removed
From line 52 where the diff opens
First seen 14 Aug 2026 this site's first read of the page
Recorded edits5to this page, all time

The whole hunk

from line 52, old and new numbered
/
lines
from line 52
5252 
5353 ID of the actor that created the object.
5454 
55 - `type: string`
55 - `type: "service_account" or "user"`
5656 
5757 Type of the actor that created the object.
5858 
59 - `"service_account"`
60 
61 - `"user"`
62 
5963 - `expires_at: string or null`
6064 
6165 RFC 3339 datetime string indicating when the API Key expires, or `null` if it never expires.
from line 74
7074 
7175 Partially redacted hint for the API key.
7276 
73 - `principal: object or null`
77 - `principal: object or object or null`
7478 
75 The ID and type of the principal the API key acts as, or `null` if the key is not bound to a principal.
79 The principal the API key acts as (a User or a Service Account), or `null` if the API key is not bound to a principal.
7680 
77 - `id: string`
81 - `UserActor object`
7882 
79 ID of the principal the API key acts as: a User ID (`user_...`) when the type is `user`, or a Service Account ID (`svac_...`) when the type is `service_account`.
83 - `type: "user_actor"`
8084 
81 - `type: "service_account" or "user"`
85 Principal type. Always `"user_actor"` for a User.
8286 
83 Type of the principal the API key acts as.
87 default: user_actor
8488 
85 - `"service_account"`
89 - `user_id: string`
8690 
87 - `"user"`
91 ID of the User the API key acts as.
8892 
93 - `ServiceAccountActor object`
94 
95 - `service_account_id: string`
96 
97 ID of the Service Account the API key acts as.
98 
99 - `type: "service_account_actor"`
100 
101 Principal type. Always `"service_account_actor"` for a Service Account.
102 
103 default: service_account_actor
104 
105 - `scope: object or object`
106 
107 Where the API key belongs: its Workspace (`{"type": "workspace", "workspace_id": "wrkspc_..."}`, with the Workspace's real ID even when it is the organization's default Workspace), or the organization (`{"type": "organization"}`) for a principal-bound API key that has no Workspace.
108 
109 - `Organization object`
110 
111 - `type: "organization"`
112 
113 Scope type. Always `"organization"`: the API key has no Workspace. Only a principal-bound API key can have this scope.
114 
115 default: organization
116 
117 - `Workspace object`
118 
119 - `type: "workspace"`
120 
121 Scope type. Always `"workspace"`: the API key belongs to one Workspace.
122 
123 default: workspace
124 
125 - `workspace_id: string`
126 
127 ID of the Workspace the API key belongs to. Unlike the deprecated top-level `workspace_id`, this is the Workspace's real ID even for the organization's default Workspace.
128 
89129 - `status: "active" or "archived" or "expired" or "inactive"`
90130 
91131 Status of the API key.
from line 148
108148 
109149 - `workspace_id: string or null`
110150 
111 ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace.
151 **Deprecated**: Use `scope` instead. `workspace_id` is `null` both for an API key in the default Workspace and for a principal-bound API key that has no Workspace.
112152 
153 Deprecated: use `scope` instead. ID of the Workspace associated with the API key, or `null` if the API key belongs to the default Workspace. Also `null` for a principal-bound API key that has no Workspace; `scope` tells the two apart.
154 
113155## Example
114156 
115157```bash
from line 176
134176 "name": "Developer Key",
135177 "partial_key_hint": "sk-ant-api03-R2D...igAA",
136178 "principal": {
137 "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
138 "type": "user"
179 "type": "user_actor",
180 "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
181 },
182 "scope": {
183 "type": "workspace",
184 "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
139185 },
140186 "status": "active",
141187 "type": "api_key",
Feedback