Skip to content
DocsOpenAPI spec

    Update Object Storage Key

    client.Storage.Keys.Update(ctx, keyID, body) (*ObjectStorageKey, error)
    PATCH/v1/storage/keys/{key_id}

    Rename an Object Storage Key. Its access key and secret do not change.

    ParametersExpand Collapse
    keyID string
    body KeyUpdateParams
    Name param.Field[string]Optional

    Name of the Object Storage Key.

    ReturnsExpand 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

    Update Object Storage Key

    package main
    
    import (
      "context"
      "fmt"
    
      "github.com/nirvana-labs/nirvana-go"
      "github.com/nirvana-labs/nirvana-go/option"
      "github.com/nirvana-labs/nirvana-go/storage"
    )
    
    func main() {
      client := nirvana.NewClient(
        option.WithAPIKey("My API Key"),
      )
      objectStorageKey, err := client.Storage.Keys.Update(
        context.TODO(),
        "key_id",
        storage.KeyUpdateParams{
    
        },
      )
      if err != nil {
        panic(err.Error())
      }
      fmt.Printf("%+v\n", objectStorageKey.ID)
    }
    
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "access_key": "0555B35654AD1656D804",
      "created_at": "2025-01-01T00:00:00Z",
      "name": "ci-uploads",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "status": "ready",
      "updated_at": "2025-01-01T00:00:00Z"
    }
    Returns Examples
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "access_key": "0555B35654AD1656D804",
      "created_at": "2025-01-01T00:00:00Z",
      "name": "ci-uploads",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "region": "us-sva-2",
      "status": "ready",
      "updated_at": "2025-01-01T00:00:00Z"
    }