Object Storage

View Object Storage Key

get
https://api.linode.com/v4beta/object-storage/keys/{keyId}
BETA

Returns a single Object Storage Key provisioned for your account.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receiving breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_only)

Path Parameters

keyId
Required
integer

The key to look up.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4beta/object-storage/keys/12345

Response Samples

{
  "id": 1234,
  "label": "my-key",
  "access_key": "KVAKUTGBA4WTR2NSJQ81",
  "secret_key": "[REDACTED]"
}

Responses

200: The keypair

id
integer

This keypair's unique ID

label
string

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

access_key
string

This keypair's access key. This is not secret.

secret_key
string

This keypair's secret key. Only returned on key creation.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Update an Object Storage Key

put
https://api.linode.com/v4beta/object-storage/keys/{keyId}
BETA

Updates an Object Storage Key on your account.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receiving breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_write)

Path Parameters

keyId
Required
integer

The key to look up.

Request Body Schema

label
string

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

Request Samples

curl -H "Content-Type: application/json" \
 -H "Authorization: Bearer $TOKEN" \
  -x PUT -d '{
    "label": "my-object-storage-key"
  }' \
  https://api.linode.com/v4beta/object-storage/keys/12345

Response Samples

{
  "id": 1234,
  "label": "my-key",
  "access_key": "KVAKUTGBA4WTR2NSJQ81",
  "secret_key": "[REDACTED]"
}

Responses

200: Update Successful

id
integer

This keypair's unique ID

label
string

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

access_key
string

This keypair's access key. This is not secret.

secret_key
string

This keypair's secret key. Only returned on key creation.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Revoke Object Storage Key

delete
https://api.linode.com/v4beta/object-storage/keys/{keyId}
BETA

Revokes an Object Storage Key. This keypair will no longer be usable by third-party clients.

Beta: This endpoint is in beta. Please make sure to prepend all requests with /v4beta instead of /v4, and be aware that this endpoint may receiving breaking updates in the future. This notice will be removed when this endpoint is out of beta.

Authorizations

Personal Access Token
OAuth: ( object_storage:read_write)

Path Parameters

keyId
Required
integer

The key to look up.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  -x DELETE \
  https://api.linode.com/v4beta/object-storage/keys/12345

Response Samples

{}

Responses

200: Deletion successful

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.