UpdateServicePrincipalKey
- Print
- DarkLight
UpdateServicePrincipalKey
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/v1/accounts/{accountId}/servicePrincipals/{servicePrincipalId}/keys/{keyId}
Availability
Early Access: July 1, 2026
Early Access is gated; contact the Backblaze Sales team for access.
Limited Availability: July 1, 2026
This API is available only to customers with access to the Backblaze Enterprise Web Console. For more information, contact the Backblaze Sales team.
Update mutable fields on a Service Principal Key
Supported updatable fields: displayName. The updateMask query parameter is required for this endpoint.
Security
HTTP
Type bearer
Short-lived bearer token obtained from GET /orgs/v1/authorize. Sent as Authorization - Bearer .
Path parameters
accountId
stringRequired
The numeric identifier of the account. Valid account IDs match 9[0-4][0-9]{10}.
Pattern^9[0-4][0-9]{10}$
Example912345678901
servicePrincipalId
stringRequired
The identifier of the service principal.
Pattern^[a-z0-9_-]{8,64}$
Examplesp-control-plane
keyId
stringRequired
The identifier of the service principal key.
Pattern^[a-z0-9_-]{8,64}$
Example019e6a8a-678e-7298-9167-4bd65df2f272
Query parameters
updateMask
stringRequired
Comma-separated list of fields to update. Supported value(s) - displayName.
ExampledisplayName
Body parameters
{
"displayName": "rotated-key"
}object
displayName
string
Examplerotated-key
Responses
200
The request succeeded.
{
"name": "accounts/942733365851/servicePrincipals/2/keys/019e6a8a-678e-7298-9167-4bd65df2f272",
"displayName": "rotated-key",
"expireTime": "2026-12-31T23:59:59Z",
"createTime": "2026-04-22T20:03:47Z",
"updateTime": "2026-04-22T20:10:00Z",
"disabled": false,
"etag": "CwYk3M1L9q2="
}object
name
string
Resource name in the form accounts//servicePrincipals//keys/.
Exampleaccounts/912345678901/servicePrincipals/123/keys/019e6a8a-678e-7298-9167-4bd65df2f272
displayName
string
Exampleprod deployer
expireTime
string (date-time)
Absolute expiration timestamp. If absent, the key does not expire.
Example2026-06-01T00:00:00Z
createTime
string (date-time)
Example2026-04-22T20:03:47Z
updateTime
string (date-time)
Example2026-04-22T20:03:47Z
disabled
boolean
When true, the key cannot mint new bearer tokens. Outstanding tokens remain valid until they expire.
Examplefalse
etag
string
Opaque concurrency token.
ExampleBwXk9a2J8p0=
400
The request was malformed or failed validation.
| HTTP Status | Code | Description |
|---|---|---|
| 400 | INVALID_ARGUMENT | One or more request parameters were invalid. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
401
The request was not authenticated.
| HTTP Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Missing, expired, or invalid bearer token. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
403
The caller is not authorized to perform this operation.
| HTTP Status | Code | Description |
|---|---|---|
| 403 | FORBIDDEN | The authenticated principal lacks permission for this action. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
404
The requested resource was not found.
| HTTP Status | Code | Description |
|---|---|---|
| 404 | NOT_FOUND | The resource does not exist or has been purged. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
409
The request conflicted with the current state of the resource.
| HTTP Status | Code | Description |
|---|---|---|
| 409 | CONFLICT | etag mismatch, resource already exists, or precondition failed. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
429
The request was rate-limited.
| HTTP Status | Code | Description |
|---|---|---|
| 429 | TOO_MANY_REQUESTS | Rate limit exceeded. Use exponential backoff. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
500
The server encountered an unexpected condition.
| HTTP Status | Code | Description |
|---|---|---|
| 500 | INTERNAL | Unexpected server error. Include the requestId when contacting support. |
object
requestId
string
Opaque correlation identifier matching the Request-Id response header. Include in support requests.
Example4bf92f3577b34da6a3ce929d0e0e4736
error
object
code
integer
Numeric error code.
Example10
message
string
Human-readable description of the error.
Exampleetag mismatch
details
object
Reserved for structured, non-sensitive diagnostic information related to the error condition.
Was this article helpful?