v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263751.6 KB

Groups

create

create a new group, a group being a collection of buckets which can be searched.

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.

post/v1/group

Request body

namestring required

The name of the group being created.

bucketNamestring

Specify bucketName to automatically create a bucket, by the name specified, and add it to the created group.

Example request

{
  "name": "your_group_name",
  "bucketName": "your_new_bucket_name"
}

Response

Group successfully created

Example response

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