--- title: "Get Storage Array" method: POST path: "/storage-array/{id}/get-item" tags: ["Storage Array"] --- # Get Storage Array `POST /storage-array/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/storage-array/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Storage Array by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` StorageArraySelectSchema: Select schema for StorageArray. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `slug` boolean - `description` boolean - `storageSystem` boolean - `reportedName` boolean - `systemId` boolean - `osName` boolean - `osVersion` boolean - `otelCollectorStatus` boolean - `agentVersion` boolean - `lastSeenAt` boolean - `capacityBytes` boolean - `usedBytes` boolean - `capacityUsedPercent` boolean - `dataReductionRatio` boolean - `openAlertCount` boolean - `criticalAlertCount` boolean - `warningAlertCount` boolean - `volumeCount` boolean - `hostCount` boolean - `podCount` boolean - `fileSystemCount` boolean - `bucketCount` boolean - `hardwareComponentCount` boolean - `unhealthyHardwareCount` boolean - `healthStatus` boolean - `createdByUserId` boolean - `isArchived` boolean - `archivedAt` boolean - `archivedByUserId` boolean - `deletedByUserId` boolean - `labels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `retainTelemetryDataForDays` boolean - `telemetryRetentionConfig` boolean ## Response `200` Successful response - object - `data` StorageArray - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `version` number: Object version - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this storage array in OneUptime. This is the join key — it must match the storage.array.name OTel resource attribute stamped by the OneUptime Storage Array Agent. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `slug` string, required: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description for this storage array. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `storageSystem` string: The storage platform this array runs, normalized from the storage.system OTel resource attribute (or detected from the metric names): purestorage.flasharray or purestorage.flashblade. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `reportedName` string: The name the array reports for itself (array_name on purefa_info / purefb_info). Can differ from the OneUptime name, which comes from the agent configuration. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `systemId` string: The array's own system identifier (system_id on purefa_info / purefb_info). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `osName` string: Name of the array's operating system as it reports it (os on purefa_info / purefb_info). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `osVersion` string: Version of the array's operating system as it reports it (version on purefa_info / purefb_info). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `otelCollectorStatus` string: Connection status of the OTel Collector agent (connected or disconnected). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `agentVersion` string: Version of the OneUptime Storage Array Agent reporting telemetry, as self-reported via the oneuptime.agent.version resource attribute. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `lastSeenAt` object: When metrics were last received from this storage array. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `capacityBytes` number: Cached usable capacity of the array in bytes (purefa_array_space_bytes{space="capacity"} / purefb_array_space_bytes{type="array",space="capacity"}). Null until the first array metric batch arrives. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `usedBytes` number: Cached physical space used on the array in bytes: capacity minus empty space, or capacity times utilization when the empty series is missing. Null until the first array metric batch arrives. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `capacityUsedPercent` number: Cached array space utilization in percent (purefa_array_space_utilization / purefb_array_space_utilization). Stored as decimal so sub-percent precision survives the round trip. Null until the first array metric batch arrives. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `dataReductionRatio` number: Cached data reduction ratio of the array (purefa_array_space_data_reduction_ratio / purefb_array_space_data_reduction_ratio), for example 4.2 for 4.2:1. Null until the first array metric batch arrives. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `openAlertCount` number: Cached count of alerts open on the array itself (purefa_alerts_open / purefb_alerts_open series, hidden alerts excluded). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `criticalAlertCount` number: Cached count of open array alerts with critical severity. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `warningAlertCount` number: Cached count of open array alerts with warning severity. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `volumeCount` number: Cached count of volumes on the array (FlashArray). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `hostCount` number: Cached count of hosts defined on the array (FlashArray). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `podCount` number: Cached count of pods (ActiveCluster / ActiveDR replication containers) on the array (FlashArray). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `fileSystemCount` number: Cached count of file systems on the array (FlashBlade). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `bucketCount` number: Cached count of object store buckets on the array (FlashBlade). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `hardwareComponentCount` number: Cached count of hardware components the array reports (chassis, controllers, drive bays, power supplies, fans, ports, blades...). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `unhealthyHardwareCount` number: Cached count of hardware components, drives and controllers in a critical, degraded, failed or unknown state. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `healthStatus` number: Cached array health derived from the array's open alerts and hardware state: 0 = OK, 1 = Warning (a warning alert, or a degraded or unknown component), 2 = Critical (a critical alert, or a failed or critical component). Rendered as the health pill. Null until the first metric batch arrives. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Edit Storage Array] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `isArchived` boolean, required: Is this storage array archived? Archived storage arrays are hidden from lists but keep collecting telemetry. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `archivedAt` object: When was this storage array archived? Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [No access - you don't have permission for this operation] - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `_id` string, uuid: Unique identifier for the entity - `retainTelemetryDataForDays` number: Number of days to retain telemetry data for this storage array. Leave blank to use the project-wide default. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] - `telemetryRetentionConfig` object: Per-pillar retention overrides for this storage array (logs by severity, traces by status, metrics, profiles). Unset fields fall back to the storage array default, then the project's retention settings. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create Storage Array], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read Storage Array], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit Storage Array] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)