Create - API documentation

This endpoint creates a new bucket within a specified data hub.

Endpoint: /bucket/create

Method: POST

Request Body Parameters:

{
  "datacenterId": "idsmjz8hspfvgatfrece4gtl",
  "name": "Data"
}

datacenterId (required, string): The ID of the datacenter where the bucket will be created. Example: idsmjz8hspfvgatfrece4gtl

name (optional, string): The name of the bucket to be created. Example: Data

Example Request:

POST /bucket/create
Content-Type: application/json

{
  "datacenterId": "idsmjz8hspfvgatfrece4gtl",
  "name": "MyNewBucket"
}

This request creates a new bucket named "MyNewBucket" within the data hub with the ID idsmjz8hspfvgatfrece4gtl.

Response Codes:

201 Created: Bucket successfully created. The response body might include details of the created bucket (e.g., its ID).

400 Bad Request: Invalid request body (e.g., missing required fields, invalid datacenterId or name).

404 Not Found: Data hub with the given ID not found.

409 Conflict: A bucket with the same name already exists within the specified data hub.

500 Internal Server Error: Server error.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create

application/json

Body

Examples

CreateException

{
    "status": 201,
    "message": "Bucket success created",
    "data": {
        "id": "c0awv0oseisvm83lru953k12",
        "code": "buc-1209-rlazyu2m",
        "name": "Data",
        "isDelete": false,
        "createdAt": "2024-12-09T21:18:26.371Z",
        "updatedAt": "2024-12-09T21:18:26.371Z",
        "deletedAt": null
    }
}

🟠400Bad Request