Update - Everabyte API

This endpoint is used to update an existing bucket.

Endpoint: /bucket/update/{bucketId}

Method: POST

Path Parameters:

bucketId (required): The ID of the bucket to be updated. Example: a1b2c3d4-e5f6-7890-1234-567890abcdef

Request Body Parameters:

{
  "name": "Backup"
}

name (optional, string): The new name for the bucket.

Example Request:

POST /bucket/update/a1b2c3d4-e5f6-7890-1234-567890abcdef
Content-Type: application/json

{
  "name": "New Backup Name"
}

This request updates the bucket with ID a1b2c3d4-e5f6-7890-1234-567890abcdef to the new name "New Backup Name".

Response Codes:

200 OK: Bucket successfully updated.

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

404 Not Found: Bucket not found.

500 Internal Server Error: Server error.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

status

integer

required

message

string

required

data

object

required

string

required

dataHubId

string

required

name

string

required

isDelete

boolean

required

createdAt

string

required

updatedAt

string

required

deletedAt

null

required

Example

{
  "status": 200,
  "message": "Bucket success updated",
  "data": {
    "id": "ad51e53icgvwbgbk2a9ptemf",
    "dataHubId": "askgxz5v57zehu303kf7agex",
    "name": "Backup",
    "isDelete": false,
    "createdAt": "2024-12-14T21:45:16.356Z",
    "updatedAt": "2025-01-09T19:26:19.643Z",
    "deletedAt": null
  }
}