Skip to content
DocsOpenAPI spec

    Create Object Storage Key

    client.Storage.Keys.New(ctx, body) (*ObjectStorageKeyWithSecret, error)
    POST/v1/storage/keys

    Create an S3 access key for a project’s Buckets in a region. The response is the only one that includes the secret access key.

    ParametersExpand Collapse
    body KeyNewParams
    Name param.Field[string]

    Name of the Object Storage Key.

    ProjectID param.Field[string]

    Project ID the Object Storage Key belongs to. The key can access the project’s Buckets in its region.

    Region param.Field[RegionName]

    Region the resource is in.

    ReturnsExpand Collapse
    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

    Create 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/shared"
      "github.com/nirvana-labs/nirvana-go/storage"
    )
    
    func main() {
      client := nirvana.NewClient(
        option.WithAPIKey("My API Key"),
      )
      objectStorageKeyWithSecret, err := client.Storage.Keys.New(context.TODO(), storage.KeyNewParams{
        Name: "ci-uploads",
        ProjectID: "123e4567-e89b-12d3-a456-426614174000",
        Region: shared.RegionNameUsSva2,
      })
      if err != nil {
        panic(err.Error())
      }
      fmt.Printf("%+v\n", objectStorageKeyWithSecret.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",
      "secret": "h7GhxuBLTrlhVUyxSPUKUV8r/2EI4ngqJxD7iBdBYLhwluN30JaT3Q==",
      "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",
      "secret": "h7GhxuBLTrlhVUyxSPUKUV8r/2EI4ngqJxD7iBdBYLhwluN30JaT3Q==",
      "status": "ready",
      "updated_at": "2025-01-01T00:00:00Z"
    }