Yamcs HTTP API
- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Create BucketΒΆ
Create a bucket
URI Template
POST /api/storage/buckets
Request Body
interface CreateBucketRequest {
// Yamcs instance name. Or _global.
instance: string;
// Bucket name
name: string;
}
Response Type
interface BucketInfo {
// Bucket name
name: string;
// Total size in bytes of all objects in the bucket (metadata is not counted)
size: string; // String decimal
// Number of objects in the bucket
numObjects: number;
// Maximum allowed total size of all objects
maxSize: string; // String decimal
// Maximum allowed number of objects
maxObjects: number;
// Creation time of this bucket
created: string; // RFC 3339 timestamp
// Bucket root directory. This field is only set when the
// bucket is mapped to the file system. Therefore it is not
// set for buckets that store objects in RocksDB.
directory: string;
}