Skip to content
DocsOpenAPI spec

    Storage

    StorageBuckets

    Create Bucket
    POST/v1/storage/buckets
    Get Bucket Details
    GET/v1/storage/buckets/{bucket_id}
    Update Bucket
    PATCH/v1/storage/buckets/{bucket_id}
    Delete Bucket
    DELETE/v1/storage/buckets/{bucket_id}
    List Buckets
    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.

    formatdate-time
    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: RegionName

    Region the resource is in.

    One of the following:
    "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 of the resource.

    One of the following:
    "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.

    formatdate-time
    url: string

    Path-style URL of the Bucket.

    BucketList 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.

    formatdate-time
    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: RegionName

    Region the resource is in.

    One of the following:
    "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 of the resource.

    One of the following:
    "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.

    formatdate-time
    url: string

    Path-style URL of the Bucket.

    StorageBucketsAvailability

    Check Create Bucket Availability
    POST/v1/storage/buckets/availability

    StorageBucketsCost

    Estimate Bucket Create Cost
    POST/v1/storage/buckets/cost

    StorageKeys

    Create Object Storage Key
    POST/v1/storage/keys
    Get Object Storage Key Details
    GET/v1/storage/keys/{key_id}
    Update Object Storage Key
    PATCH/v1/storage/keys/{key_id}
    Delete Object Storage Key
    DELETE/v1/storage/keys/{key_id}
    List Object Storage Keys
    GET/v1/storage/keys
    ModelsExpand Collapse
    ObjectStorageKey object { id, access_key, created_at, 5 more }

    Object Storage Key details. The secret access key is only returned when the key is created.

    id: string

    Unique identifier for the Object Storage Key.

    access_key: string

    S3 access key ID.

    created_at: string

    When the Object Storage Key was created.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time
    ObjectStorageKeyList object { items, pagination }
    items: array of ObjectStorageKey { id, access_key, created_at, 5 more }
    id: string

    Unique identifier for the Object Storage Key.

    access_key: string

    S3 access key ID.

    created_at: string

    When the Object Storage Key was created.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time
    ObjectStorageKeyWithSecret object { id, access_key, created_at, 6 more }

    Object Storage Key details, including the secret access key. Returned only when the key is created.

    id: string

    Unique identifier for the Object Storage Key.

    access_key: string

    S3 access key ID.

    created_at: string

    When the Object Storage Key was created.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"
    secret: string

    S3 secret access key. It is only returned here and cannot be retrieved again: store it securely, or delete the key and create a new one if it is lost.

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time