Skip to main content

Retrieve a bucket for a cloud provider

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/object-storage/{provider}/{objectStoreName}

Retrieves a specific bucket for the specified cloud provider.

Parameters

Name Type In Required Description

accountId

string

path

True

Account ID

provider

string

path

True

Cloud provider type

  • enum: ["AWS", "GCP", "AZURE", "SGWS", "ONTAP_S3"]

objectStoreName

string

path

True

Bucket name

authorization

string

header

True

Authorization token

X-Agent-Id

string

header

True

Agent ID

Response

Status: 200, Default response
Name Type Required Description

object-store-name

string

True

Bucket name

region

string

False

Bucket region

provider

string

True

Cloud provider

account-id

string

False

Account ID for the AWS provider

project-id

string

False

Project ID for the Google Cloud provider

subscription

string

False

Subscription for the Azure provider

encryption

string

False

Encryption type used for the bucket

is-public

boolean

False

Indicates whether the bucket is public

object-lock

string

False

Object lock enabled for the bucket

resource-group

string

False

Resource group for the Azure provider

tags

array[tags]

False
Example response 
{
  "object-store-name": "string",
  "region": "string",
  "provider": "string",
  "account-id": "string",
  "project-id": "string",
  "subscription": "string",
  "encryption": "string",
  "object-lock": "string",
  "resource-group": "string",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

Definitions

See Definitions

tags

Name Type Required Description

key

string

False

Tag key

value

string

False

Tag value