API Reference

Rename Bucket

post
https://{serverid}.nexusrun.com/databases/{databaseid}/buckets//rename

This API endpoint is used to rename an existing bucket in the NexusRunDB database with a new name.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

  • Please note that only the Master access key or a token generated for the Master access key is allowed to access this endpoint.

  • You need to pass the new ID of the bucket in the HTTP request body. The API will use this new ID to rename the bucket in the database.

  • If a bucket with the same ID already exists, a Bad Request (400) response will be returned. This indicates that the requested operation cannot be completed due to a conflicting bucket ID.

  • The maximum length for a bucket ID is 128 bytes, and the use of forward slashes ( / ) is not allowed in the bucket ID.

  • Unicode characters are allowed in the new bucket ID.

Path Params
string
required

This is the unique database id you provided while creating database.

string
required

This is short name for the database location. This will be shown when new database is created at portal.

Body Params
string

Bucket's new id should be passed in Body. Max length is 128 bytes and forward slash ( / ) is not allowed.

Headers
string

You need to pass either "Basic 'accesskey:accesssecret'" (base 64 encoded) or "Bearer {token}" authorization header.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated over 2 years ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json

Updated over 2 years ago