Object Storage

Object Storage TLS/SSL Cert View

get
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/ssl

Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl

Response Samples

{
  "ssl": true
}

Responses

200: Returns a boolean value indicating if this bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.

ssl
boolean

A boolean indicating if this Bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.

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.

Object Storage TLS/SSL Cert Upload

post
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/ssl

Upload a TLS/SSL certificate and private key to be served when you visit your Object Storage bucket via HTTPS. Your TLS/SSL certificate and private key are stored encrypted at rest.

To replace an expired certificate, delete your current certificate and upload a new one.

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Body Schema

certificate
Required
string

Your Base64 encoded and PEM formatted SSL certificate.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI)

private_key
Required
string

The private key associated with this TLS/SSL certificate.

Line breaks must be represented as "\n" in the string for requests (but not when using the Linode CLI)

Request Samples

curl -H "Content-Type: application/json" \
    -H "Authorization: Bearer $TOKEN" \
    -X POST -d '{
        "certificate": "-----BEGIN CERTIFICATE-----\nCERTIFICATE_INFORMATION\n-----END CERTIFICATE-----",
        "private_key": "-----BEGIN PRIVATE KEY-----\nPRIVATE_KEY_INFORMATION\n-----END PRIVATE KEY-----"
      }' \
    https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl

Response Samples

{
  "ssl": true
}

Responses

200: Returns whether this bucket has a corresponding TLS/SSL certificate that was uploaded by a user.

ssl
boolean

A boolean indicating if this Bucket has a corresponding TLS/SSL certificate that was uploaded by an Account user.

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.

Object Storage TLS/SSL Cert Delete

delete
https://api.linode.com/v4/object-storage/buckets/{clusterId}/{bucket}/ssl

Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.

Path Parameters

clusterId
Required
string

The ID of the cluster this bucket exists in.

bucket
Required
string

The bucket name.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
    -X DELETE \
    https://api.linode.com/v4/object-storage/buckets/us-east-1/example-bucket/ssl

Response Samples

{}

Responses

200: Deletes this Object Storage bucket's user uploaded TLS/SSL certificate and private key.

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.