Skip to main content

Retrieve a list of StorageGRID buckets

POST /account/{accountId}/providers/cloudmanager_cbs/api/v1/sg/buckets

Retrieves a list of StorageGRID buckets from the StorageGRID server.

Token usage: NetApp Console user token.

Parameters

Name Type In Required Description

fields

string

query

False

bucket fields

accountId

string

path

True

Account ID

authorization

string

header

True

User token

X-Agent-Id

string

header

True

Request identifier

Request Body

Name Type Required Description

storage-server

string

True

StorageGRID server URL. Required input field for a StorageGRID provider

access-key

string

True

Required input field for an on-premises use case

secret-password

string

True

Required input field for an on-premises use case
Example request 
{
  "storage-server": "string",
  "access-key": "string",
  "secret-password": "string"
}

Response

Status: 200, Default response
Name Type Required Description

buckets

array[buckets]

False
Example response 
{
  "buckets": [
    {
      "name": "string",
      "region": "string"
    }
  ]
}

Definitions

See Definitions

body

Name Type Required Description

storage-server

string

True

StorageGRID server URL. Required input field for a StorageGRID provider

access-key

string

True

Required input field for an on-premises use case

secret-password

string

True

Required input field for an on-premises use case

buckets

Name Type Required Description

name

string

False

region

string

False