Skip to main content
GET/storage/locations

List Storage Locations

Lists the project's active storage locations: the customer's own object stores (bring your own store) that buckets and datasets can be linked to.

Retired locations are not listed.

Parameters
projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
403K9O_ACCESS_DENIEDYour role does not permit listing storage locations for this project.
Response body (200)
data *object[]

The project's active locations, newest first.

id *string

The location id (byos_...).

projectId *string

The project the location belongs to (proj_...).

provider *"s3" | "s3_compatible" | "gcs" | "azure_blob" | "minio" | "r2" | "b2"

The storage provider. s3_compatible is any S3 API at endpointOverride.

bucketName *string

The bucket or container name at the provider.

region *string

The platform region the data belongs to.

providerRegion *string

The bucket's region at its provider.

endpointOverride *any

The custom endpoint URL, or null when none is set.

One of: string
or: null
credentialRef *string

The credential reference (kibo://byos-creds/sec_...).

The secret itself is never returned.

custodyMode *"PLATFORM_MANAGED" | "BYOK" | "HYOK"

Who holds the encryption keys for data written to the location.

providerParams *object

The non-secret provider settings as stored, string keys with string values; an empty object when none were given.

createdAt *string <date-time>

When the location was created.

retiredAt *any

When the location was retired, or null while it is active.

List results are always active; a read by id also returns a retired location.

One of: string <date-time>
or: null
meta *any
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.storage.locations.list()

Showing example in TypeScript

Response example (200)
{
  "data": [
    {
      "id": "string",
      "projectId": "string",
      "provider": "s3",
      "bucketName": "string",
      "region": "string",
      "providerRegion": "string",
      "endpointOverride": "string",
      "credentialRef": "string",
      "custodyMode": "PLATFORM_MANAGED",
      "createdAt": "string",
      "retiredAt": "string"
    }
  ]
}

More in Storage & Schema