Skip to content
DocsOpenAPI spec

    Storage

    StorageBuckets

    Create Bucket
    client.Storage.Buckets.New(ctx, body) (*Operation, error)
    POST/v1/storage/buckets
    Get Bucket Details
    client.Storage.Buckets.Get(ctx, bucketID) (*Bucket, error)
    GET/v1/storage/buckets/{bucket_id}
    Update Bucket
    client.Storage.Buckets.Update(ctx, bucketID, body) (*Bucket, error)
    PATCH/v1/storage/buckets/{bucket_id}
    Delete Bucket
    client.Storage.Buckets.Delete(ctx, bucketID, body) (*Operation, error)
    DELETE/v1/storage/buckets/{bucket_id}
    List Buckets
    client.Storage.Buckets.List(ctx, query) (*Cursor[Bucket], error)
    GET/v1/storage/buckets
    ModelsExpand Collapse
    type Bucket struct{…}

    Bucket details.

    ID string

    Unique identifier for the Bucket.

    CreatedAt Time

    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.

    ObjectCount int64

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

    ProjectID string

    Project ID the Bucket belongs to.

    Region RegionName

    Region the resource is in.

    One of the following:
    const RegionNameUsSva2 RegionName = "us-sva-2"
    const RegionNameUsWdc1 RegionName = "us-wdc-1"
    SigningRegion 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.

    SizeBytes int64

    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:
    const ResourceStatusPending ResourceStatus = "pending"
    const ResourceStatusCreating ResourceStatus = "creating"
    const ResourceStatusUpdating ResourceStatus = "updating"
    const ResourceStatusReady ResourceStatus = "ready"
    const ResourceStatusDeleting ResourceStatus = "deleting"
    const ResourceStatusDeleted ResourceStatus = "deleted"
    const ResourceStatusError ResourceStatus = "error"
    const ResourceStatusSuspended ResourceStatus = "suspended"
    Tags []string

    Tags attached to the Bucket.

    UpdatedAt Time

    When the Bucket was updated.

    formatdate-time
    URL string

    Path-style URL of the Bucket.

    type BucketList struct{…}
    Items []Bucket
    ID string

    Unique identifier for the Bucket.

    CreatedAt Time

    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.

    ObjectCount int64

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

    ProjectID string

    Project ID the Bucket belongs to.

    Region RegionName

    Region the resource is in.

    One of the following:
    const RegionNameUsSva2 RegionName = "us-sva-2"
    const RegionNameUsWdc1 RegionName = "us-wdc-1"
    SigningRegion 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.

    SizeBytes int64

    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:
    const ResourceStatusPending ResourceStatus = "pending"
    const ResourceStatusCreating ResourceStatus = "creating"
    const ResourceStatusUpdating ResourceStatus = "updating"
    const ResourceStatusReady ResourceStatus = "ready"
    const ResourceStatusDeleting ResourceStatus = "deleting"
    const ResourceStatusDeleted ResourceStatus = "deleted"
    const ResourceStatusError ResourceStatus = "error"
    const ResourceStatusSuspended ResourceStatus = "suspended"
    Tags []string

    Tags attached to the Bucket.

    UpdatedAt Time

    When the Bucket was updated.

    formatdate-time
    URL string

    Path-style URL of the Bucket.

    StorageBucketsAvailability

    Check Create Bucket Availability
    client.Storage.Buckets.Availability.New(ctx, body) error
    POST/v1/storage/buckets/availability

    StorageBucketsCost

    Estimate Bucket Create Cost
    client.Storage.Buckets.Cost.New(ctx, body) (*CostQuote, error)
    POST/v1/storage/buckets/cost

    StorageKeys

    Create Object Storage Key
    client.Storage.Keys.New(ctx, body) (*ObjectStorageKeyWithSecret, error)
    POST/v1/storage/keys
    Get Object Storage Key Details
    client.Storage.Keys.Get(ctx, keyID) (*ObjectStorageKey, error)
    GET/v1/storage/keys/{key_id}
    Update Object Storage Key
    client.Storage.Keys.Update(ctx, keyID, body) (*ObjectStorageKey, error)
    PATCH/v1/storage/keys/{key_id}
    Delete Object Storage Key
    client.Storage.Keys.Delete(ctx, keyID) error
    DELETE/v1/storage/keys/{key_id}
    List Object Storage Keys
    client.Storage.Keys.List(ctx, query) (*Cursor[ObjectStorageKey], error)
    GET/v1/storage/keys
    ModelsExpand Collapse
    type ObjectStorageKey struct{…}

    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.

    AccessKey string

    S3 access key ID.

    CreatedAt Time

    When the Object Storage Key was created.

    formatdate-time
    Name string

    Name of the Object Storage Key.

    ProjectID string

    Project ID the Object Storage Key belongs to.

    Region RegionName

    Region the resource is in.

    One of the following:
    const RegionNameUsSva2 RegionName = "us-sva-2"
    const RegionNameUsWdc1 RegionName = "us-wdc-1"

    Status of the resource.

    One of the following:
    const ResourceStatusPending ResourceStatus = "pending"
    const ResourceStatusCreating ResourceStatus = "creating"
    const ResourceStatusUpdating ResourceStatus = "updating"
    const ResourceStatusReady ResourceStatus = "ready"
    const ResourceStatusDeleting ResourceStatus = "deleting"
    const ResourceStatusDeleted ResourceStatus = "deleted"
    const ResourceStatusError ResourceStatus = "error"
    const ResourceStatusSuspended ResourceStatus = "suspended"
    UpdatedAt Time

    When the Object Storage Key was updated.

    formatdate-time
    type ObjectStorageKeyList struct{…}
    ID string

    Unique identifier for the Object Storage Key.

    AccessKey string

    S3 access key ID.

    CreatedAt Time

    When the Object Storage Key was created.

    formatdate-time
    Name string

    Name of the Object Storage Key.

    ProjectID string

    Project ID the Object Storage Key belongs to.

    Region RegionName

    Region the resource is in.

    One of the following:
    const RegionNameUsSva2 RegionName = "us-sva-2"
    const RegionNameUsWdc1 RegionName = "us-wdc-1"

    Status of the resource.

    One of the following:
    const ResourceStatusPending ResourceStatus = "pending"
    const ResourceStatusCreating ResourceStatus = "creating"
    const ResourceStatusUpdating ResourceStatus = "updating"
    const ResourceStatusReady ResourceStatus = "ready"
    const ResourceStatusDeleting ResourceStatus = "deleting"
    const ResourceStatusDeleted ResourceStatus = "deleted"
    const ResourceStatusError ResourceStatus = "error"
    const ResourceStatusSuspended ResourceStatus = "suspended"
    UpdatedAt Time

    When the Object Storage Key was updated.

    formatdate-time
    type ObjectStorageKeyWithSecret struct{…}

    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.

    AccessKey string

    S3 access key ID.

    CreatedAt Time

    When the Object Storage Key was created.

    formatdate-time
    Name string

    Name of the Object Storage Key.

    ProjectID string

    Project ID the Object Storage Key belongs to.

    Region RegionName

    Region the resource is in.

    One of the following:
    const RegionNameUsSva2 RegionName = "us-sva-2"
    const RegionNameUsWdc1 RegionName = "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:
    const ResourceStatusPending ResourceStatus = "pending"
    const ResourceStatusCreating ResourceStatus = "creating"
    const ResourceStatusUpdating ResourceStatus = "updating"
    const ResourceStatusReady ResourceStatus = "ready"
    const ResourceStatusDeleting ResourceStatus = "deleting"
    const ResourceStatusDeleted ResourceStatus = "deleted"
    const ResourceStatusError ResourceStatus = "error"
    const ResourceStatusSuspended ResourceStatus = "suspended"
    UpdatedAt Time

    When the Object Storage Key was updated.

    formatdate-time