Request Methods for Storage Domains
This is detailed information about the request methods for tenant storage domains. 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/
Note
Storage domain names are converted to lowercase before evaluation.
See Defined ETC Documents for more on ETC documents (IDSYS, Policy, XFORM).
List Tenant Domains
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains |
Query Args |
|
Headers |
|
Policy Action | ListDomains |
Description | Returns a list of storage domains owned by the tenant. |
Restrictions |
|
Request Body |
|
Response | JSON formatted tenant listing response |
Create Storage Domain
Method | PUT |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain} |
Query Args |
|
Headers | Optional metadata to be saved with domain |
Policy Action | CreateDomain |
Description | Create a domain named {domain}. If domain already exists, this action overwrites the metadata for the domain. |
Restrictions | Domain name must be 7-bit ASCII characters in the set [a-z, 0-9, hyphen]. |
Request Body |
|
Response | JSON general request response |
Read Storage Domain
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain} |
Query Args |
|
Headers |
|
Policy Action | GetDomain |
Description | Reads a storage domain object and metadata. |
Restrictions |
|
Request Body |
|
Response | Domain object body (normally null) and metadata |
Delete Storage Domain
Method | DELETE |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain} |
Query Args | recursive=yes (required) |
Headers |
|
Policy Action | DeleteDomain |
Description | Deletes all data related to the storage domain. |
Restrictions |
|
Request Body |
|
Response | JSON general request response |
List Storage Domain ETC Documents
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain}/etc |
Query Args |
|
Headers |
|
Policy Action | ListEtc |
Description | Returns a list of storage domain documents. |
Restrictions | Paging is not supported in the request; only 1000 returned at this time. |
Request Body |
|
Response | JSON formatted documents listing response |
Create Storage Domain ETC Document
Method | PUT |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain}/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 storage domain. |
Restrictions | Maximum document size is 1MB. |
Request Body | The document contents |
Response | JSON general request response |
Read Storage Domain ETC Document
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain}/etc/{document} |
Query Args |
|
Headers |
|
Policy Action | GetPolicy |
Description | Read a storage domain document. |
Restrictions |
|
Request Body |
|
Response | Document body and metadata |
Delete Storage Domain ETC Document
Method | DELETE |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain}/etc/{document} |
Query Args |
|
Headers |
|
Policy Action | DeletePolicy |
Description | Delete a storage domain document |
Restrictions |
|
Request Body |
|
Response | JSON general request response |
Get Domain UUID by Name
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains/{domain}/uuid |
Query Args |
|
Headers |
|
Policy Action | GetDomain |
Description | Returns the UUID (context ID) for a domain |
Restrictions |
|
Request Body |
|
Response | JSON general request response |
Get Domain Name by UUID
Method | GET |
---|---|
URI Suffix | tenants/{tenant}/domains/{domainUUID}/name |
Query Args |
|
Headers |
|
Policy Action | GetDomain |
Description | Returns the canonical name for a domain |
Restrictions |
|
Request Body |
|
Response | JSON general request response |
© DataCore Software Corporation. · https://www.datacore.com · All rights reserved.