Skip to content
Stratum Docs
Search
Ctrl
K
Cancel
Documentation version
Stratum 0.7.0
Content width
Normal
Wide
Full
Select theme
Dark
Light
Auto
Menu
Documentation
stratumctl
API
API
Overview
meta
iam
platform
regions
audit
network
compute
storage
Overview
List a project's S3 access keys (secrets never returned).
GET
Issue a new S3 access key for the project.
POST
Revoke an S3 access key.
DELETE
Retrieve an S3 access key's secret.
GET
List S3 buckets in a project.
GET
Create an S3 bucket.
POST
Get an S3 bucket.
GET
Delete an S3 bucket.
DELETE
Get a bucket's S3 policy.
GET
Set a bucket's S3 policy.
PUT
Clear a bucket's S3 policy.
DELETE
Get a bucket's data-management settings.
GET
Set a bucket's data-management settings.
PUT
List objects in a bucket.
GET
Upload an object (CP-proxied).
PUT
Delete an object.
DELETE
Mint a presigned object URL.
POST
List volumes in a project.
GET
Create a volume.
POST
Describe a volume.
GET
Soft-delete a volume.
DELETE
Update displayName / description / labels.
PATCH
Attach a volume to an instance.
POST
Detach a volume from its instance.
POST
Recover an errored volume back to `available`.
POST
Grow a volume online.
POST
List snapshots in a project.
GET
Create a snapshot of a volume.
POST
Describe a snapshot.
GET
Delete a snapshot.
DELETE
Update displayName / description / labels.
PATCH
Restore a new volume from a snapshot.
POST
List the images the project can launch.
GET
Create a project-scoped image by promoting a snapshot.
POST
Import an image from an object in one of the project's buckets.
POST
Describe an image.
GET
Deregister (delete) an owned image.
DELETE
Update displayName / description / labels.
PATCH
Export an image to an object in one of the project's buckets.
POST
Create a volume from an image.
POST
Share an image with other projects.
POST
Revoke a share.
POST
Make an image public.
POST
Take an image off the public list.
POST
Deprecate an image, now or at a scheduled time.
POST
Clear a deprecation (and any schedule).
POST
Disable an image: launches are refused until it is enabled.
POST
Re-enable a disabled image.
POST
List images install-wide (admin).
GET
Import a global or region image from a URL.
POST
Upload a disk image (qcow2 or raw) into the image catalog.
POST
The curated cloud-image quick-pick catalog.
GET
List the base-image catalog (admin).
GET
Add base images from the catalog (admin).
POST
Describe an image install-wide (admin).
GET
Delete an image install-wide (admin).
DELETE
Per-node staging state for an image (admin).
GET
Deprecate any image (admin).
POST
Undeprecate any image (admin).
POST
Disable any image (admin).
POST
Enable any image (admin).
POST
Ceph cluster health roll-up (bootstrap-admin).
GET
Per-OSD placement + utilization (bootstrap-admin).
GET
Provision an OSD on an explicit device — bootstrap-admin.
POST
Drain an OSD (mark out) — bootstrap-admin.
POST
Return a drained OSD to service (mark in) — bootstrap-admin.
POST
Set an OSD's override reweight — bootstrap-admin.
POST
Destroy an OSD's identity (decommission) — bootstrap-admin.
POST
In-flight OSD removal (drain) progress — bootstrap-admin.
GET
Purge + zap an OSD (full decommission) — bootstrap-admin.
POST
Set/unset OSDMap maintenance flags — bootstrap-admin.
POST
List Ceph daemon crash reports — bootstrap-admin.
GET
Acknowledge a Ceph daemon crash — bootstrap-admin.
POST
Acknowledge every outstanding Ceph crash — bootstrap-admin.
POST
Ceph rolling-upgrade status — bootstrap-admin.
GET
Start a cephadm rolling upgrade — bootstrap-admin.
POST
Pause the running Ceph upgrade — bootstrap-admin.
POST
Resume a paused Ceph upgrade — bootstrap-admin.
POST
Stop (cancel) the Ceph upgrade — bootstrap-admin.
POST
Recent Ceph cluster log events — bootstrap-admin.
GET
Ceph device inventory with reject reasons — bootstrap-admin.
GET
The disks installs reserved for a day-2 Ceph bootstrap — bootstrap-admin.
GET
Cephadm host membership — bootstrap-admin.
GET
Drain all cephadm daemons off a host — bootstrap-admin.
POST
Remove a host from cephadm management — bootstrap-admin.
DELETE
Enter/exit cephadm host maintenance — bootstrap-admin.
POST
Monitor placement + quorum membership (bootstrap-admin).
GET
Request a Day-2 Ceph cluster bootstrap (bootstrap-admin).
POST
Request a Day-2 Ceph cluster teardown (bootstrap-admin).
POST
Object-storage health (admin diagnostic).
GET
Live Ceph RADOS Gateway (S3) service status (bootstrap-admin).
GET
Deploy the Ceph RADOS Gateway — S3 object storage (bootstrap-admin).
POST
Desired + observed Ceph cluster state (bootstrap-admin).
GET
Partially update the desired Ceph cluster spec (bootstrap-admin).
PATCH
List desired Ceph pools (bootstrap-admin).
GET
Create/update a Ceph pool (storage tier) — bootstrap-admin.
POST
Get one Ceph pool — bootstrap-admin.
GET
Delete a Ceph pool (storage tier) — bootstrap-admin.
DELETE
Update a Ceph pool's params (storage tier) — bootstrap-admin.
PATCH
List storage classes.
GET
Create a storage class.
POST
Describe a storage class.
GET
Delete a storage class.
DELETE
Update a storage class.
PATCH
Storage class capacity + utilization stats.
GET
List storage pools (operator-only).
GET
Create a storage pool from disk(s) (operator-only).
POST
Describe a storage pool (operator-only).
GET
Delete an empty storage pool (operator-only).
DELETE
Explore a storage pool's contents (operator-only).
GET
Add disk(s) to a pool to grow it (operator-only).
POST
Remove disk(s) from a pool to shrink it (operator-only).
POST
Poll a cross-node disk/pool intent (operator-only).
GET
Create an image from a running or stopped instance (async).
POST
lb
dns
observability
backup
ssh-ca
operations
quotas
inventory
advisor
secrets
asg
db
admin
backup-admin
observability-admin
join
Documentation version
Stratum 0.7.0
Content width
Normal
Wide
Full
Select theme
Dark
Light
Auto
Overview
storage
Section titled “storage”
Volumes, snapshots, storage classes + pools.
Operations
Section titled “Operations”
GET
/v1/projects/{projectId}/objectstorage/access-keys
POST
/v1/projects/{projectId}/objectstorage/access-keys
DELETE
/v1/projects/{projectId}/objectstorage/access-keys/{accessKeyId}
GET
/v1/projects/{projectId}/objectstorage/access-keys/{accessKeyId}/secret
GET
/v1/projects/{projectId}/objectstorage/buckets
POST
/v1/projects/{projectId}/objectstorage/buckets
GET
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}
DELETE
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}
GET
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/policy
PUT
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/policy
DELETE
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/policy
GET
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/settings
PUT
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/settings
GET
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/objects
PUT
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/objects
DELETE
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/objects
POST
/v1/projects/{projectId}/objectstorage/buckets/{bucketId}/objects/presign
GET
/v1/projects/{projectId}/compute/volumes
POST
/v1/projects/{projectId}/compute/volumes
GET
/v1/projects/{projectId}/compute/volumes/{volumeId}
DELETE
/v1/projects/{projectId}/compute/volumes/{volumeId}
PATCH
/v1/projects/{projectId}/compute/volumes/{volumeId}
POST
/v1/projects/{projectId}/compute/volumes/{volumeId}/actions/attach
POST
/v1/projects/{projectId}/compute/volumes/{volumeId}/actions/detach
POST
/v1/projects/{projectId}/compute/volumes/{volumeId}/actions/recover
POST
/v1/projects/{projectId}/compute/volumes/{volumeId}/actions/resize
GET
/v1/projects/{projectId}/compute/snapshots
POST
/v1/projects/{projectId}/compute/snapshots
GET
/v1/projects/{projectId}/compute/snapshots/{snapshotId}
DELETE
/v1/projects/{projectId}/compute/snapshots/{snapshotId}
PATCH
/v1/projects/{projectId}/compute/snapshots/{snapshotId}
POST
/v1/projects/{projectId}/compute/snapshots/{snapshotId}/actions/create-volume
GET
/v1/projects/{projectId}/compute/images
POST
/v1/projects/{projectId}/compute/images
POST
/v1/projects/{projectId}/compute/images/import
GET
/v1/projects/{projectId}/compute/images/{imageId}
DELETE
/v1/projects/{projectId}/compute/images/{imageId}
PATCH
/v1/projects/{projectId}/compute/images/{imageId}
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/export
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/create-volume
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/share
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/unshare
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/publish
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/unpublish
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/deprecate
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/undeprecate
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/disable
POST
/v1/projects/{projectId}/compute/images/{imageId}/actions/enable
GET
/v1/images
POST
/v1/images
POST
/v1/images/upload
GET
/v1/images/catalog
GET
/v1/images/base-images
POST
/v1/images/base-images/actions/add
GET
/v1/images/{imageId}
DELETE
/v1/images/{imageId}
GET
/v1/images/{imageId}/node-status
POST
/v1/images/{imageId}/actions/deprecate
POST
/v1/images/{imageId}/actions/undeprecate
POST
/v1/images/{imageId}/actions/disable
POST
/v1/images/{imageId}/actions/enable
GET
/v1/admin/storage/ceph/status
GET
/v1/admin/storage/ceph/osds
POST
/v1/admin/storage/ceph/osds
POST
/v1/admin/storage/ceph/osds/{id}/out
POST
/v1/admin/storage/ceph/osds/{id}/in
POST
/v1/admin/storage/ceph/osds/{id}/reweight
POST
/v1/admin/storage/ceph/osds/{id}/destroy
GET
/v1/admin/storage/ceph/osd-removals
POST
/v1/admin/storage/ceph/osds/{id}/purge
POST
/v1/admin/storage/ceph/flags
GET
/v1/admin/storage/ceph/crashes
POST
/v1/admin/storage/ceph/crashes/{crashId}/actions/archive
POST
/v1/admin/storage/ceph/crashes/actions/archive-all
GET
/v1/admin/storage/ceph/upgrade
POST
/v1/admin/storage/ceph/upgrade
POST
/v1/admin/storage/ceph/upgrade/pause
POST
/v1/admin/storage/ceph/upgrade/resume
POST
/v1/admin/storage/ceph/upgrade/stop
GET
/v1/admin/storage/ceph/events
GET
/v1/admin/storage/ceph/devices
GET
/v1/admin/storage/ceph/osd-candidates
GET
/v1/admin/storage/ceph/hosts
POST
/v1/admin/storage/ceph/hosts/{host}/drain
DELETE
/v1/admin/storage/ceph/hosts/{host}
POST
/v1/admin/storage/ceph/hosts/{host}/maintenance
GET
/v1/admin/storage/ceph/mons
POST
/v1/admin/storage/ceph/bootstrap
POST
/v1/admin/storage/ceph/teardown
GET
/v1/admin/objectstorage/health
GET
/v1/admin/storage/ceph/rgw
POST
/v1/admin/storage/ceph/rgw
GET
/v1/admin/storage/ceph/cluster
PATCH
/v1/admin/storage/ceph/cluster
GET
/v1/admin/storage/ceph/pools
POST
/v1/admin/storage/ceph/pools
GET
/v1/admin/storage/ceph/pools/{name}
DELETE
/v1/admin/storage/ceph/pools/{name}
PATCH
/v1/admin/storage/ceph/pools/{name}
GET
/v1/storage-classes
POST
/v1/storage-classes
GET
/v1/storage-classes/{storageClassName}
DELETE
/v1/storage-classes/{storageClassName}
PATCH
/v1/storage-classes/{storageClassName}
GET
/v1/storage-classes/{storageClassName}/stats
GET
/v1/storage-pools
POST
/v1/storage-pools
GET
/v1/storage-pools/{poolId}
DELETE
/v1/storage-pools/{poolId}
GET
/v1/storage-pools/{poolId}/contents
POST
/v1/storage-pools/{poolId}/actions/extend
POST
/v1/storage-pools/{poolId}/actions/shrink
GET
/v1/node-storage-intents/{intentId}
POST
/v1/projects/{projectId}/compute/instances/{instanceId}/actions/create-image
