Request Methods for Buckets

This is detailed information about the request methods for buckets. Using these methods with cURL has this format (here, for listing):

curl -i -u caringoadmin:pwd https://site.example.com/_admin/manage/tenants/t1/domains/d1.site.example.com/buckets/

See  for more on ETC documents (IDSYS, Policy, XFORM).

List Buckets

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets

Query Args

 

Headers

 

Policy Action

ListBuckets

Description

Returns a list of buckets in the domain

Restrictions

 

Request Body

 

Response

JSON-formatted listing response

Create Bucket

Method

PUT

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}

Query Args

 

Headers

Optional metadata to be saved with bucket

Policy Action

CreateBucket

Description

Create a bucket named {bucket}. If it already exists, this action overwrites the metadata for the bucket.

Restrictions

Name must be 7-bit ASCII characters in the set [a-z, 0-9, hyphen]

Request Body

 

Response

JSON general request response

Read Bucket

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}

Query Args

 

Headers

 

Policy Action

GetBucket

Description

Reads a bucket object and metadata.

Restrictions

 

Request Body

 

Response

Bucket object body (normally null) and metadata

Delete Bucket

Method

DELETE

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}

Query Args

recursive=yes (required)

Headers

 

Policy Action

DeleteBucket

Description

Deletes all data related to the bucket

Restrictions

 

Request Body

 

Response

JSON general request response

List Bucket ETC Documents

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}/etc

Query Args

 

Headers

 

Policy Action

ListEtc

Description

Returns a list of bucket documents

Restrictions

Paging is not supported in the request; only 1000 returned

Request Body

 

Response

JSON-formatted documents listing response

Create Bucket ETC Documents

Method

PUT

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}/etc/{document}

Query Args

 

Headers

Any metadata to be included with the document

Policy Action

PutPolicy

Description

Create or overwrite a document associated with the bucket

Restrictions

Maximum document size is 1MB

Request Body

The document contents

Response

JSON general request response

Read Bucket ETC Documents

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}/etc/{document}

Query Args

 

Headers

 

Policy Action

GetPolicy

Description

Read a bucket document

Restrictions

 

Request Body

 

Response

Document body and metadata

Delete Bucket ETC Documents

Method

DELETE

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}/etc/{document}

Query Args

 

Headers

 

Policy Action

DeletePolicy

Description

Delete a bucket document

Restrictions

 

Request Body

 

Response

JSON general request response

Get Bucket UUID by Name

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucket}/uuid

Query Args

 

Headers

 

Policy Action

GetBucket

Description

Returns the UUID (context ID) for a bucket

Restrictions

 

Request Body

 

Response

JSON general request response

Get Bucket Name by UUID

Method

GET

URI Suffix

tenants/{tenant}/domains/{domain}/buckets/{bucketUUID}/name

Query Args

 

Headers

 

Policy Action

GetBucket

Description

Returns the canonical name for a bucket

Restrictions

 

Request Body

 

Response

JSON general request response

 

© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.