Get an Object Storage key

get

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

Returns a single Object Storage access key.

linode-cli object-storage keys-view \
  --keyId 12345

Learn more...

object_storage:read_only

Learn more...

Responses

Response body

object

access_key

string

A unique string chosen by the API to identify this key. Used as a username to identify this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

bucket_access

array of objects

Settings that limit access to specific buckets, each with a specific permission level. See Create a limited access key for more information.

bucket_access

object

bucket_name

string

The name of the bucket the key can access in the region.

cluster

string

Deprecated For backwards compatibility, this is included to identify the legacy cluster equivalent of the region where this key can be used. The key grants access to each specified bucket_name, based on the permissions set.

📘
Use of clusters in a limited access key has been deprecated.

permissions

string

enum

The level of access the key grants to the bucket_name. Keys with read_write access can manage content in the bucket_name, while read_only can be used to view content.

read_write read_only

region

string

The region where the bucket_name resides.

integer

This Object Storage key's unique ID.

label

string

The label given to this key. For display purposes only.

limited

boolean

Whether this Object Storage key limits access to specific buckets and permissions. Returns false if this key grants full access. Specific limitations are set in bucket_access.

regions

array of objects

The key can be used in these regions to manage buckets.

regions

object

endpoint_type

string

enum

The type of s3_endpoint available to the active user in this region. See Endpoint types for more information.

E0 E1 E2 E3

string

Identifies each region where you can use the Object Storage key.

For an unlimited key. Each id represents an individual region you set in the regions array, when you set up the key. See Create an unlimited access key for more information.
For a limited access key. The API server populates each object in this array with each of the individual instances of the region parameter you set in the bucket_access array. See Create a limited access key for more information.

s3_endpoint

string

The S3-compatible hostname you can use to access the Object Storage buckets in this region.

secret_key

string

This Object Storage key's secret key. Used as a password to validate this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

📘
This value is listed as [REDACTED] for this operation, to protect it. It's only revealed in a response after creating a key.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/object-storage/keys/keyId \
3
     --header 'accept: application/json'


xxxxxxxxxx
22
 
1
{
2
  "access_key": "ABCDEFGHI1JKL2MNOP34",
3
  "bucket_access": [
4
    {
5
      "bucket_name": "example-bucket",
6
      "cluster": "us-west-1",
7
      "permissions": "read_only",
8
      "region": "us-west"
9
    }
10
  ],
11
  "id": 123,
12
  "label": "my-key",
13
  "limited": true,
14
  "regions": [
15
    {
16
      "endpoint_type": "E1",
17
      "id": "us-west",
18
      "s3_endpoint": "us-west-00.linodeobjects.com"
19
    }
20
  ],
21
  "secret_key": "[REDACTED]"
22
}

200The key pair.

defaultSee Errors for the range of possible error response codes.