Skip to content
DocsOpenAPI spec

    Buckets

    Create Bucket
    $ nirvana storage:buckets create
    POST/v1/storage/buckets
    Get Bucket Details
    $ nirvana storage:buckets get
    GET/v1/storage/buckets/{bucket_id}
    Update Bucket
    $ nirvana storage:buckets update
    PATCH/v1/storage/buckets/{bucket_id}
    Delete Bucket
    $ nirvana storage:buckets delete
    DELETE/v1/storage/buckets/{bucket_id}
    List Buckets
    $ nirvana storage:buckets list
    GET/v1/storage/buckets
    ModelsExpand Collapse
    bucket: object { id, created_at, endpoint, 10 more }

    Bucket details.

    id: string

    Unique identifier for the Bucket.

    created_at: string

    When the Bucket was created.

    endpoint: string

    S3 endpoint of the Bucket’s region. Point S3 clients at it, with an Object Storage Key of the same project and region.

    name: string

    Name of the Bucket, used to address it over S3.

    object_count: number

    Number of objects in the Bucket. Updated periodically, so it can lag behind recent writes.

    project_id: string

    Project ID the Bucket belongs to.

    region: "us-sva-2" or "us-wdc-1"

    Region the resource is in.

    "us-sva-2"
    "us-wdc-1"
    signing_region: string

    Region S3 clients must sign their requests for (the SigV4 region). Configure it as the region of any S3 client or SDK used with the Bucket.

    size_bytes: number

    Total size of the objects in the Bucket, in bytes. Updated periodically, so it can lag behind recent writes.

    status: "pending" or "creating" or "updating" or 5 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    tags: array of string

    Tags attached to the Bucket.

    updated_at: string

    When the Bucket was updated.

    url: string

    Path-style URL of the Bucket.

    bucket_list: object { items, pagination }
    items: array of Bucket { id, created_at, endpoint, 10 more }
    id: string

    Unique identifier for the Bucket.

    created_at: string

    When the Bucket was created.

    endpoint: string

    S3 endpoint of the Bucket’s region. Point S3 clients at it, with an Object Storage Key of the same project and region.

    name: string

    Name of the Bucket, used to address it over S3.

    object_count: number

    Number of objects in the Bucket. Updated periodically, so it can lag behind recent writes.

    project_id: string

    Project ID the Bucket belongs to.

    region: "us-sva-2" or "us-wdc-1"

    Region the resource is in.

    "us-sva-2"
    "us-wdc-1"
    signing_region: string

    Region S3 clients must sign their requests for (the SigV4 region). Configure it as the region of any S3 client or SDK used with the Bucket.

    size_bytes: number

    Total size of the objects in the Bucket, in bytes. Updated periodically, so it can lag behind recent writes.

    status: "pending" or "creating" or "updating" or 5 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    tags: array of string

    Tags attached to the Bucket.

    updated_at: string

    When the Bucket was updated.

    url: string

    Path-style URL of the Bucket.

    BucketsAvailability

    Check Create Bucket Availability
    $ nirvana storage:buckets:availability create
    POST/v1/storage/buckets/availability

    BucketsCost

    Estimate Bucket Create Cost
    $ nirvana storage:buckets:cost create
    POST/v1/storage/buckets/cost