Skip to content
DocsOpenAPI spec

    Keys

    Create Object Storage Key
    POST/v1/storage/keys
    Get Object Storage Key Details
    GET/v1/storage/keys/{key_id}
    Update Object Storage Key
    PATCH/v1/storage/keys/{key_id}
    Delete Object Storage Key
    DELETE/v1/storage/keys/{key_id}
    List Object Storage Keys
    GET/v1/storage/keys
    ModelsExpand Collapse
    ObjectStorageKey object { id, access_key, created_at, 5 more }

    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.

    access_key: string

    S3 access key ID.

    created_at: string

    When the Object Storage Key was created.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time
    ObjectStorageKeyList 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.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "us-wdc-1"

    Status of the resource.

    One of the following:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time
    ObjectStorageKeyWithSecret object { id, access_key, created_at, 6 more }

    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.

    access_key: string

    S3 access key ID.

    created_at: string

    When the Object Storage Key was created.

    formatdate-time
    name: string

    Name of the Object Storage Key.

    project_id: string

    Project ID the Object Storage Key belongs to.

    region: RegionName

    Region the resource is in.

    One of the following:
    "us-sva-2"
    "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:
    "pending"
    "creating"
    "updating"
    "ready"
    "deleting"
    "deleted"
    "error"
    "suspended"
    updated_at: string

    When the Object Storage Key was updated.

    formatdate-time