Update an Object Storage access key

put

https://api.linode.com/{apiVersion}/object-storage/keys/{keyId}

Updates an Object Storage access key on your account. A successful request triggers an obj_access_key_update event.

📘
This operation has specific rate limits.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: object_storage:read_write

CLI

linode-cli object-storage keys-update \
  --keyId 12345
  --label "my-object-storage-key"

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

keyId

integer

required

The key to look up.

Body Params

label

string

The label for the Object Storage key. Used for display purposes. Omit this to leave the label unchanged.

regions

array of strings

Replace the current list of regions set in a specific key. Include an existing region to keep it, or leave it out to remove it. Omit the regions array to leave the existing list unchanged. If you include new regions in the key, you can't immediately use the key to manage content in buckets in those regions. You need to grant these keys this access using bucket policies.

🚧
Limited keys have restrictions
These points apply to keys you've created using the bucket_access array:

You can't remove a region from a limited key's original bucket_access list. If you include the regions array in this operation and target a limited key, you need to include all existing region entries from the bucket_access array. Otherwise, the operation fails with an error. Run Get an Object Storage key to review current region entries in a limited key.

If you need to remove a specific region from an active limited key, you can revoke the key and create a new Object Storage key, without the specific region.

regions

Responses

Limited keys have restrictions

200Update Successful.

defaultSee Errors for the range of possible error response codes.