---
title: "Get file storage"
method: GET
path: "/api/v2/filestorage/{filestorageID}"
tags: ["File storage"]
---

# Get file storage

`GET /api/v2/filestorage/{filestorageID}`

Get all storage information this ID.

## Response `200`

A storage.

- StorageV2Read — A storage read only group.
  - `metadata` ProjectScopedResourceReadMetadata, required — Metadata required for all API resource reads and writes.
    - `name` string, required — A valid Kubernetes label value, typically used for resource names that can be indexed in the database.
    - `description` string — The resource description, this optionally augments the name with more context.
    - `tags` Tag[] — A list of tags.
      - `name` string, required — A unique tag name.
      - `value` string, required — The value of the tag.
    - `id` string, required — The unique resource ID.
    - `creationTime` string, date-time, required — The time the resource was created.
    - `createdBy` string — The user who created the resource.
    - `modifiedTime` string, date-time — The time a resource was updated.
    - `modifiedBy` string — The user who updated the resource.
    - `deletionTime` string, date-time — The time the resource was deleted.
    - `provisioningStatus` 'unknown' | 'provisioning' | 'provisioned' | 'deprovisioning' | 'error', required — The provisioning state of a resource.
    - `healthStatus` 'unknown' | 'healthy' | 'degraded' | 'error', required — The health state of a resource.
    - `organizationId` string, required — The organization identifier the resource belongs to.
    - `projectId` string, required — The project identifier the resource belongs to.
  - `spec` StorageV2Spec, required — A storage's specification.
    - `sizeGiB` integer, required — size in GiB of the storage
    - `storageType` StorageTypeV2Spec, required — A storage's type
      - `NFS` NFSV2Spec — NFS specific
        - `rootSquash` boolean, required — root squash
    - `attachments` StorageAttachmentV2Spec — Describes the network attachment for storage
      - `networkIds` string[], required — A list of network IDs
    - `defaultSnapshotProtectionEnabled` boolean — Whether platform-managed Default Snapshot Protection is enabled. On create, omission resolves to enabled. On update, omission preserves the current setting. Reads return the resolved setting. Explicit null is invalid.
    - `snapshotPolicies` StorageSnapshotPolicyV2Spec[] — A list of named snapshot policies for storage.
      - `name` string, required — Stable identity key for the snapshot policy.
      - `schedule` StorageSnapshotScheduleV2Spec, required — Schedule for a storage snapshot policy.
        - `interval` 'hourly' | 'daily' | 'weekly' | 'monthly', required — Snapshot policy cadence.
        - `timeOfDay` string — UTC time of day in HH:MMZ form.
        - `dayOfWeek` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday' — UTC day of week for weekly snapshot policies.
        - `dayOfMonth` integer — UTC day of month for monthly snapshot policies.
      - `retention` StorageSnapshotRetentionV2Spec, required — Retention policy for storage snapshots.
        - `keep` integer, required — Number of snapshots to retain.
  - `status` StorageV2Status, required — Read only status about storage
    - `storageClassId` string, required — identifier for the storage
    - `regionId` string, required — The region an identity is provisioned in.
    - `usage` StorageUsageV2Status — Information about the usage of the storage in bytes
      - `capacityBytes` integer, required — total space allotted in bytes
      - `usedBytes` integer — amount of storage space used in bytes
      - `updatedAt` string, date-time — timestamp when the usage was last updated
    - `attachments` StorageAttachmentV2Status[] — Describes the network attachments for storage
      - `networkId` string, required — The network ID
      - `mountSource` string — The mount source for the attached storage in the format <host>:<path>.
      - `mountOptions` object — Optional NFS mount options for the attached storage.
      - `provisioningStatus` 'unknown' | 'provisioning' | 'provisioned' | 'deprovisioning' | 'error', required — The provisioning state of a resource.
    - `snapshotPolicies` StorageSnapshotPolicyV2Status[], required — A list of observed snapshot policy states for storage.
      - `name` string, required — Stable identity key for the snapshot policy.
      - `provisioningStatus` 'unknown' | 'provisioning' | 'provisioned' | 'deprovisioning' | 'error', required — The provisioning state of a resource.
      - `message` string — Optional human-readable status detail for the snapshot policy.

## Other responses

- `400` — Request body failed schema validation, or the request does not contain all the required fields.
- `401` — Authentication failed or the access token has expired.
- `403` — Request was denied by authorization, this may be caused by the authorization token not having the required scope for an API, or the user doesn't have the necessary privileges on the provider platform.
- `404` — Unable to find a resource.
- `500` — An unexpected or unhandled error occurred. This may be a transient error and may succeed on a retry. If this isn't the case, please report it as an issue.

---

[API](https://skmtc.net/nscale/apis/region-service-api.md) · [All operations](https://skmtc.net/nscale/apis/region-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nscale/region-service-api/revisions/c2991b23da6e/schema)