Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Create Storage Class

POST
/storage/v1/engines/{engine}/storage-classes
 
curl --request POST \
  --url https://example.com/storage/v1/engines/example/storage-classes \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "display_name": "example", "description": "example", "is_default": true, "qibdo": { "redundancy": "REDUNDANCY_UNSPECIFIED", "performance_class": "PERFORMANCE_CLASS_UNSPECIFIED", "compression_type": "example" } }'

Creates a new storage class on the given cloud provider. A specific provider is required. Storage class names must match ^[A-Z][A-Z0-9_]{0,63}$ and be unique within the region for that provider.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
engine
required
string

The cloud provider to create the storage class on: qibdo, aws, gcp, or azure

Request Body required

Section titled “Request Body required ”
Media type application/json

A storage class is a global storage tier — declared once, it carries the durability intent (redundancy + performance class) and compression a bucket may select, independent of any region. The tier is materialized into each region’s backing store on demand; the per-region readiness is reported separately by the storage class instance. Storage classes can be defined across different cloud providers; the provider is reported by the read-only engine field.

object
id

The unique identifier of the storage class

stringOutput only
name
required

The storage class name (1–64 chars, uppercase alphanumeric and underscores). Must match ^[A-Z][A-Z0-9_]{0,63}$. Examples: STANDARD, REDUCED_REDUNDANCY, ARCHIVE.

string
display_name

An optional human-readable label for the storage class. Free text, mutable, and not an identifier — use name to address the tier.

string
description

An optional human-readable description of the storage class

string
is_default

Whether this is the global default tier for its provider. Buckets that omit a storage class inherit the default. At most one default exists per provider.

boolean
engine

The cloud provider this storage class is provisioned on.

string format: enum Output only
Allowed values: ENGINE_UNSPECIFIED ENGINE_QIBDO ENGINE_AWS ENGINE_GCP ENGINE_AZURE
created

Timestamp when the storage class was created

string format: date-time Output only
updated

Timestamp when the storage class was last updated

string format: date-time Output only
qibdo

Attributes specific to a Qibdo-managed storage class.

object
redundancy
required

The redundancy scheme the tier guarantees (replication factor or erasure-coding profile).

string format: enum
Allowed values: REDUNDANCY_UNSPECIFIED REDUNDANCY_REPLICATED_2 REDUNDANCY_REPLICATED_3 REDUNDANCY_REPLICATED_4 REDUNDANCY_ERASURE_CODED_2_1 REDUNDANCY_ERASURE_CODED_4_2 REDUNDANCY_ERASURE_CODED_6_3 REDUNDANCY_ERASURE_CODED_8_3
performance_class
required

The performance class the tier targets (media tier).

string format: enum
Allowed values: PERFORMANCE_CLASS_UNSPECIFIED PERFORMANCE_CLASS_STANDARD PERFORMANCE_CLASS_FAST_SSD PERFORMANCE_CLASS_FAST_NVME PERFORMANCE_CLASS_ARCHIVE
compression_type

The compression type for data in this storage class (NONE, SNAPPY, ZLIB, ZSTD, LZ4)

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

StorageOperation tracks the result of a storage command (bucket or object operation).

object
id

Unique operation identifier

stringOutput only
resource_id

The ID of the affected resource (bucket ID; null for object-only ops)

stringOutput only
resource_type

The type of resource (“Bucket” or “Object”)

stringOutput only
operation_type

The operation type (CREATE, UPDATE, DELETE, COPY)

stringOutput only
status

The operation status (PENDING, RUNNING, DONE, ERROR)

stringOutput only
insert_time

When the operation was created

string format: date-time Output only
start_time

When execution started

string format: date-time Output only
end_time

When execution completed

string format: date-time Output only
progress

Progress percentage (0–100)

integer format: int32 Output only
Example generated
{}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}