Object Storage

View Cluster

get
https://api.linode.com/v4beta/object-storage/clusters/{clusterId}
BETA

Returns a single Object Storage Cluster.

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.

Path Parameters

clusterId
Required
string

The ID of the Cluster.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
  https://api.linode.com/v4beta/object-storage/clusters/us-east-1

Response Samples

{
  "id": 1234,
  "status": "available",
  "domain": "us-east-1.linodeobjects.com",
  "region": "us-east",
  "static_site_domain": "website-us-east-1.linodeobjects.com"
}

Responses

200: The requested Cluster

id
string

The unique ID for this cluster.

status
string
Enum: "available""unavailable"

This cluster's status.

domain
string

The base URL for this cluster, used for connecting with third-party clients.

region
string

The region where this cluster is located.

static_site_domain
string

The base URL for this cluster used when hosting static sites.

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.