Skip to content

BucketApi ​

All URIs are relative to http://localhost

MethodHTTP requestDescription
clearBucketDELETE /mongodb/buckets/{bucketName}/clearClear Bucket
deleteBucketDELETE /mongodb/buckets/Delete Bucket
getBucketGET /mongodb/buckets/Bucket Information
listBucketsGET /mongodb/bucketsList of Buckets

clearBucket ​

JsonValue_Boolean clearBucket(bucketName)

Clear Bucket

Delete all Files in Bucket

Parameters ​

NameTypeDescriptionNotes
bucketNameStringThe name of your MongoDb Collection[default to null]

Return type ​

JsonValue_Boolean

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

deleteBucket ​

JsonValue_Boolean deleteBucket(bucketName)

Delete Bucket

Delete a given Bucket

Parameters ​

NameTypeDescriptionNotes
bucketNameStringThe name of your MongoDb Collection[default to null]

Return type ​

JsonValue_Boolean

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

getBucket ​

BucketInformation getBucket(bucketName)

Bucket Information

All Information about a single Bucket

Parameters ​

NameTypeDescriptionNotes
bucketNameStringThe name of your MongoDb Collection[default to null]

Return type ​

BucketInformation

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

listBuckets ​

List listBuckets()

List of Buckets

List of all Buckets of the default database

Parameters ​

This endpoint does not need any parameter.

Return type ​

List

Authorization ​

httpAuth1, httpAuth, apiKeyAuth

HTTP request headers ​

  • Content-Type: Not defined
  • Accept: application/json

Released under the Apache License 2.0.