Skip to content
DocsOpenAPI spec

    Keys

    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