Buckets

list

List all buckets within your GroundX account

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

get/v1/bucket

Query parameters

ninteger

The maximum number of returned buckets. Accepts 1-100 with a default of 20.

nextTokenstring

A token for pagination. If the number of buckets for a given query is larger than n, the response will include a "nextToken" value. That token can be included in this field to retrieve the next batch of n buckets.

Response

Look up success

Example response

{
  "buckets": [
    {
      "created": "2023-10-03T08:59:39.312Z",
      "fileSize": "3.1GB",
      "updated": "2023-10-03T08:59:39.312Z"
    }
  ]
}

Changes

Changed in 7 of the 50 revisions of this API.1413

Nov 29, 20233bb5650586362See the full diff
- ○
  added the new optional query request parameter n
  new-optional-request-parameter
- ○
  added the new optional query request parameter nextToken
  new-optional-request-parameter
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 29, 2023bf7061385e181See the full diff
- ○
  removed the non-success response with the status
  response-non-success-status-removed
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 13, 202343657b55255e2See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Oct 5, 20235ee59ea914aa2See the full diff
- ○
  api tag Buckets added
  api-tag-added
- ○
  api tag Bucket removed
  api-tag-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 5, 2023006f5c1a8d401See the full diff
- ○
  the response property // became required for the status
  response-property-became-required
Oct 4, 20237d474e21a1082See the full diff
- ○
  api operation id getBuckets removed and replaced with Bucket_list
  api-operation-id-removed
- ○
  api tag Bucket added
  api-tag-added
Oct 4, 202379c42de78d2f143See the full diff
- ▲
  the response property // became optional for the status
  response-property-became-optional
- ●
  deleted the query request parameter n
  request-parameter-removed
- ●
  deleted the query request parameter nextToken
  request-parameter-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ○
  api operation id Bucket_list removed and replaced with getBuckets
  api-operation-id-removed
- ○
  api tag Buckets removed
  api-tag-removed
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 30 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history