Skip to content
DocsOpenAPI spec

    List Object Storage Keys

    $ nirvana storage:keys list
    GET/v1/storage/keys

    List all Object Storage Keys. Secret access keys are not included.

    ParametersExpand Collapse
    --project-id: string

    Project ID of resources to request

    --cursor: optional string

    Pagination cursor returned by a previous request. Only valid for the same filters and sort order.

    --limit: optional number

    Maximum number of items to return

    --name: optional string

    Filter by a case-insensitive substring of the Object Storage Key name

    --region: optional string

    Filter by region

    --sort: optional string

    Comma-separated sort terms in precedence order, each field:asc or field:desc. Fields: created_at, updated_at, name

    ReturnsExpand Collapse
    object_storage_key_list: 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.

    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: "us-sva-2" or "us-wdc-1"

    Region the resource is in.

    "us-sva-2"
    "us-wdc-1"
    status: "pending" or "creating" or "updating" or 5 more

    Status of the resource.

    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    List Object Storage Keys

    nirvana storage:keys list \
      --api-key 'My API Key' \
      --project-id project_id
    {
      "items": [
        {
          "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"
        }
      ],
      "pagination": {
        "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
        "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
        "total_count": 125
      }
    }
    Returns Examples
    {
      "items": [
        {
          "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"
        }
      ],
      "pagination": {
        "next_cursor": "RhwniMT4B74siYZcPF8TnCdGI1l9rpPvg",
        "previous_cursor": "ARhwnmi1hA7wEbHbMjdYQlOB_ZusP4fYvw",
        "total_count": 125
      }
    }