Create - Everabyte API

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

Endpoint: /bucket/create

Method: POST

Request Body Parameters:

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

dataHubId (required, string): The ID of the data hub where the bucket will be created. Example: idsmjz8hspfvgatfrece4gtl

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

Example Request:

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

{
  "dataHubId": "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 dataHubId 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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

dataHubId

string

required

name

string

required

Example

{
  "dataHubId": "askgxz5v57zehu303kf7agex",
  "name": "Data"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create

application/json

Body

status

integer

required

message

string

required

data

object

required

string

required

code

string

required

name

string

required

isDelete

boolean

required

createdAt

string

required

updatedAt

string

required

deletedAt

null

required

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