/storage/locations/{locationId}Get Storage Location
Gets one active storage location of the project by id.
A retired location answers 404.
| locationId * | path | The storage location's id ( |
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 403 | K9O_ACCESS_DENIED | Your role does not permit reading this storage location. |
| 404 | K9O_NOT_FOUND | No storage location with this id exists in the project. |
| data * | object | A storage location: a bucket at an outside provider that the project's storage writes to. |
| id * | string | The location id ( |
| projectId * | string | The project the location belongs to ( |
| provider * | "s3" | "s3_compatible" | "gcs" | "azure_blob" | "minio" | "r2" | "b2" | The storage provider. |
| 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 ( 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 | |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.storage.locations.get('<locationId>')Showing example in TypeScript
{
"data": {
"id": "string",
"projectId": "string",
"provider": "s3",
"bucketName": "string",
"region": "string",
"providerRegion": "string",
"endpointOverride": "string",
"credentialRef": "string",
"custodyMode": "PLATFORM_MANAGED",
"createdAt": "string",
"retiredAt": "string"
}
}