Dell ObjectScale 1.3 Administration Guide

PDF

ObjectScale Management REST API summary

The ObjectScale Management REST API manages and configures ObjectScale and object stores.

Table 1. ObjectScale-level, Object Store-level, and Object Service APIs - methods summaryThe following table summarizes the ObjectScale-level APIs.
API Area	Description
ObjectScale Management APIs
Management APIs create and manage ObjectScale-level management users.
Local User APIs (non-RKE)	/mgmt/users APIs (non-RKE platform only) for creating and managing ObjectScale level management users.
Local Account APIs (RKE)	/mgmt/local-accounts APIs (RKE platform only) for creating and managing ObjectScale level management account.
Authentication and Login APIs	/mgmt/auth/login APIs for getting and managing management users token.
Local Account Config APIs (RKE)	/mgmt/local-accounts-config APIs (RKE platform only) for creating and managing ObjectScale level management account security config.
Role APIs (non-RKE)	/mgmt/roles APIs (non-rke platform only) for creating and managing ObjectScale level management users.
Role APIs (RKE)	/mgmt/roles This API is for viewing management roles only (not for creating and managing).
Role-Mapping APIs (RKE)	/mgmt/ldap-role-mappings APIs (RKE platform only) for creating and managing ObjectScale level LDAP and management role mappings.
LDAP Auth Provider APIs (RKE)	/mgmt/ldaps APIs (RKE platform only) for creating and managing ObjectScale level management LDAP provider.
Federation APIs create and manage ObjectScale-level federations.
Federation APIs	/fedsvc API interface for Federation Operations.
Feature APIs	/fedsvc/feature API interface for Federation Feature Operations.
IAM APIs manage IAM users, roles, and policies in an account. The APIs assume a role and obtain temporary access credentials.
IAM Actions	/iam API interface for Identity And Access Management Operations.
STS Actions	/sts API interface for Secure Token Service Operations.
Object Store Management APIs
The Metering API gets metrics on object stores, including bucket information, replication status, and performance.
Objmt	/object/mt API for getting object store metrics and failed replication errors. Errors are classified by error code.
The Recovery API retrieves recovery status for a device or partition.
Recovery	/vdc/recovery-status/ API for getting recovery status.
Replication APIs control ObjectScale replication. This API allows you to pause, suspend, resume, and throttle replication.
Replication Control	/replication/control API for ObjectScale replication control. It allows you to pause, suspend, resume, and throttle replication.
Replication Info	replication/info API to get ObjectScale replication info.
Data Transition Control	/datatransition/control/ API for ObjectScale replication Data Transition Controls.
The Monitoring API retrieves audit events for a specified namespace.
Events	/vdc/events API for fetching audit alerts.
The Multitenancy API provisions and manages tenants.
Account Tenant	/object/tenants API for provisioning and managing tenant.
The Provisioning API provisions and manages buckets.
Bucket	/object/bucket API for provisioning and managing buckets and view into replication failures by error code.
Object Store Object Service API
Amazon S3 APIs	API to manage Amazon S3. S3 Bucket S3 Bucket ACL S3 Bucket Cors S3 Bucket Is Stale Allowed S3 Bucket Lifecycle S3 Bucket List Uploads S3 Bucket Location S3 Bucket Lock Configuration Operations S3 Bucket Notification Operations S3 Bucket Object Lock Operations S3 Bucket Policy S3 Bucket Replication Operations S3 Bucket Versioning S3 Bucket Versions S3 Data Node S3 Metadata Key List S3 Metadata Key System List S3 Metadata Search S3 Multi Object Delete S3 Object S3 Object ACL S3 Object Detailed Replication Status Operations S3 Object Init Uploads S3 Object Legal Hold Operations S3 Object Replication Info Operations S3 Object Retention Operations S3 Object Tagging Operations S3 Object Uploads S3 Options S3 Ping S3 Retention Update Operation S3 Select Operations