About IBM Storage Ceph as a Service APIs

IBM Storage Ceph as a Service provides you with two APIs to configure and manage your storage resources.

These IBM Storage Ceph as a Service APIs use IBM Cloud® Identity and Access Management for authorize and authenticate requests.

As the Cloud Identity and Access Management tokens are relatively easy to work with, curl is a good choice for basic testing and interaction with your storage. More information can be found in the curl reference.

The following sections describe the complete set of operations of the IBM Storage Ceph as a Service API.

Block storage management API

Use the Block storage management api to programmatically provision and manage block storage resources within the IBM Storage Ceph as a Service deployment, including volumes, hosts, and volume to host mappings.

Block operations

These operations create, delete, get information about, and control the behavior of block storage.

Block storage operation
Block operation	Action
`GET /volumes`	Used to retrieve a list of all block volumes.
`DELETE /volumes/{id}`	Deletes a volume.
`POST /volumes`	Create volume in a deployment.
`GET /volumes/{id}`	Retrieves a single volume.
`PATCH /volumes/{id}`	Updates the name or capacity of a volume.
`GET /hosts`	Retrieves a list of all hosts in the deployment
`POST /hosts`	Creates a new host.
`DELETE /host/{id}`	Deletes a specific host.
`GET /hosts/{id}`	Retrieves a specific host.
`PATCH /hosts/{id}`	Updates the host information.
`POST /hosts/{id}/volume_mappings`	Create a Volume mapping for a host.
`GET /hosts/{id}/volume_mappings/{volume_mapping_id}`	Retrieves a single volume mapping.
`GET /hosts/{id}/volume_mappings`	Retrieves the lists volume mappings for a host.
`DELETE /hosts/{id}/volume_mappings/{volume_mapping_id}`	Deletes the specific volume mapping.
`DELETE /hosts/{id}/volume_mappings`	Deletes all volume mappings for a host.

Object storage administration API

Administration operations

These operations create, delete, get information about, and control the behavior of administration objects.

Object admin operation
Administration operation	Note
`POST /certificates/{cert_type}`	Create an S3 certificate.
`PUT /certificates/{cert_type}`	Replace or update the S3 certificate
`GET /certificates/{cert_type}`	Retrieves the certificate status.
`DELETE /certificates/{cert_type}`	Deletes the S3 certificate.
`GET /certificates`	Retrieves the list of configured certificates
`POST /s3_credentials/{access_key}`	Creates S3 credential for object.
`GET /s3_credentials`	Retrieves one or more S3 credentials.
`DELETE /s3_credentials/{access_key}`	Deletes the S3 credential.

Object storage S3 API

The IBM® Storage Ceph® as a Service Object Storage S3 API is a REST-based API for reading and writing objects.

This IBM Storage Ceph as a Service API uses IBM Cloud® Identity and Access Management for authentication and authorization, and supports a subset of the S3 API for easy migration of applications to IBM Cloud.

Object operations

These operations create, delete, get information about, and control the behavior of S3 objects.

Object operation
Object operation	Note
`DELETE` Object	Deletes an object from a bucket.
`DELETE` Batch	Deletes many objects from a bucket with one operation.
`GET` Object	Retrieves an object from a bucket.
`HEAD` Object	Retrieves an object's headers.
`PUT` Object	Adds an object to a bucket.
`PUT` Object (Copy)	Creates a copy of an object.
Begin Multipart Upload	Creates an upload ID for a set of parts to be uploaded.
Upload Part	Uploads a part of an object that is associated with an upload ID.
Upload Part (Copy)	Uploads a part of an existing object that is associated with an upload ID.
Complete Multipart Upload	Assembles an object from parts that are associated with an upload ID.
Cancel Multipart Upload	Cancels upload and deletes outstanding parts that are associated with an upload ID.
List Parts	Returns a list of parts that are associated with an upload ID.

Bucket operations

These operations create, delete, get information about, and control the behavior of buckets.

Bucket operation
Bucket operation	Note
`GET` Buckets	Used to retrieve a list of all buckets that belong to an account.
`DELETE` Bucket	Deletes an empty bucket.
`GET` Bucket	Lists objects in a bucket. Limited to listing 1,000 objects at a time.
`HEAD` Bucket	Retrieves a bucket's headers.
`GET` Multipart Uploads	Lists multipart uploads that aren't completed or canceled.
`PUT` Bucket	Buckets have naming restrictions. Accounts are limited to 100 buckets.

More information about IBM Storage Ceph as a Service features and use-cases can be found at ibm.com.