Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Get one file share with all detail panels
Retrieves the full read model behind the file share detail page for a single file share in the active
scope: identity and description, protocol + protocolVersion, status, tier, provisioned/used
capacity, provisioned IOPS and throughput, encryption flag and KMS key, mount path/UNC, the
embedded mount targets (network/subnet/IP/zone), the snapshot list, the access rules
(CIDR-based for NFS, AD group/SID-based for SMB), the AD domain for SMB shares, and the per-GB
monthly price in hundredths of the currency unit. This one response feeds the Overview, Snapshots and Access tabs.
Validation: scopeId must resolve to an accessible scope and fileShareId to a live
(non-soft-deleted) share within it — unknown or soft-deleted ids → 404 NOT_FOUND. RBAC: any
scope role (owner|admin|contributor|reader|billing) may read.
Async & state: Synchronous read; no state change. The detail page subscribes to
resource.updated SSE frames with kind "storage.file_share" for live status/capacity patches.
Errors: 401 unauthenticated; 403 no role on the scope; 404 unknown scopeId or
fileShareId; 500 unexpected backend failure.
Idempotency/Concurrency: Safe, cacheable; no idempotency key required. The response carries
an ETag usable as If-Match on subsequent mutations of this share.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
The file share detail read model.
application/json- response
Managed NFS/SMB file share read model rendered by the File shares page and the file share detail page.
origin?stringWhere the resource was made -- portal for a create on the console, api for an object made straight against the OpenStack API (CLI, Terraform, the Kubernetes cloud provider) that discovery adopted. Informational; nothing behaves differently. Absent from a backend that predates it, which means portal.
"portal""api""system""imported"id*stringShare identifier (e.g. fs_home_nfs).
name*stringShare name — used in the mount path / UNC name.
description*stringFree-text description of the share's purpose.
protocol*stringAccess protocol of the share.
"NFS""SMB"protocolVersion*stringConcrete protocol dialect (e.g. "NFS 4.1", "SMB 3.1.1").
status*stringLifecycle status of the share.
"AVAILABLE""CREATING""UPDATING""ERROR"statusReason*|Human-readable, customer-facing reason the last lifecycle command on this share failed: the canonical sentence of the failure's class (a provider refusal is summarised, never quoted -- the provider's own text stays operator-only), or the platform's own explanation. Null while healthy, once a later settle clears it, or when the failure carried no detail.
tier*stringPerformance tier (Standard general purpose, Premium low-latency SSD, Burst credit-based).
"Standard""Premium""Burst"provisionedGb*integerProvisioned capacity in GB (billed capacity; minimum 100).
usedGb*integerCurrently used capacity in GB.
iops*integerProvisioned IOPS for the tier.
throughputMbps*integerProvisioned throughput in MB/s for the tier.
encrypted*booleanWhether data is encrypted at rest (AES-256) and in transit.
kmsKeyId*|Customer-managed KMS key for encryption; null when encryption is off.
mountPath*stringBase mount path (NFS export host:/path) or UNC name (SMB).
mountTargets*array<>Network endpoints serving the share.
snapshots*array<>Point-in-time snapshots of the share, newest first.
accessRules*array<>Client-access rules (CIDR for NFS, AD group/SID for SMB).
adDomain*|Active Directory domain for SMB shares; null for NFS shares.
pricePerGbMonthlyCents*integerPer-GB monthly price in hundredths of the currency unit (an integer, not a Money object); a fixed figure per tier, not the rate billing charges.
createdAt*stringCreation timestamp (ISO 8601).
date-timeupdatedAt*stringLast modification timestamp (ISO 8601).
date-timecurl -X GET "https://example.com/scopes/string/storage/file-shares/string"{ "origin": "portal", "id": "string", "name": "string", "description": "string", "protocol": "NFS", "protocolVersion": "string", "status": "AVAILABLE", "statusReason": "string", "tier": "Standard", "provisionedGb": 0, "usedGb": 0, "iops": 0, "throughputMbps": 0, "encrypted": true, "kmsKeyId": "string", "mountPath": "string", "mountTargets": [ { "id": "string", "network": "string", "subnet": "string", "ip": "string", "zone": "string" } ], "snapshots": [ { "id": "string", "name": "string", "sizeGb": 0, "createdAt": "2019-08-24T14:15:22Z", "automatic": true } ], "accessRules": [ { "id": "string", "source": "string", "permission": "rw", "rootSquash": true, "description": "string" } ], "adDomain": "string", "pricePerGbMonthlyCents": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}