--- title: "Get IoT Fleet" method: POST path: "/iot-fleet/{id}/get-item" tags: ["IoT Fleet"] --- # Get IoT Fleet `POST /iot-fleet/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/iot-fleet/{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 IoT Fleet by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` IoTFleetSelectSchema: Select schema for IoTFleet. 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 - `otelCollectorStatus` boolean - `agentVersion` boolean - `lastSeenAt` boolean - `deviceCount` boolean - `onlineDeviceCount` 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` IoTFleet - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `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 IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this IoT fleet. This is the join key — it must match the iot.fleet.name OTel resource attribute stamped by the IoT device or gateway. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `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 IoT Fleet], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description for this IoT fleet. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `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 IoT Fleet], Update: [Project Owner, Project Admin, Edit IoT Fleet] - `agentVersion` string: Version of the IoT 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 IoT Fleet], Update: [Project Owner, Project Admin, Edit IoT Fleet] - `lastSeenAt` object: When metrics were last received from this fleet. 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 IoT Fleet], Update: [Project Owner, Project Admin, Edit IoT Fleet] - `deviceCount` number: Cached count of devices in this fleet. 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 IoT Fleet], Update: [Project Owner, Project Admin, Edit IoT Fleet] - `onlineDeviceCount` number: Cached count of devices currently online (iot_device_up == 1) in this fleet. Rendered as 'Devices X/Y online' next to deviceCount. 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 IoT Fleet], Update: [Project Owner, Project Admin, Edit IoT Fleet] - `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 IoT Fleet], Update: [No access - you don't have permission for this operation] - `isArchived` boolean, required: Is this IoT fleet archived? Archived IoT fleets are hidden from lists but keep collecting telemetry. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `archivedAt` object: When was this IoT fleet 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 IoT Fleet], 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 IoT Fleet], 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 IoT Fleet], 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 IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `_id` string, uuid: Unique identifier for the entity - `retainTelemetryDataForDays` number: Number of days to retain telemetry data for this IoT fleet. Leave blank to use the project-wide default. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] - `telemetryRetentionConfig` object: Per-pillar retention overrides for this IoT fleet (logs by severity, traces by status, metrics, profiles). Unset fields fall back to the IoT fleet default, then the project's retention settings. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create IoT Fleet], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read IoT Fleet], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit IoT Fleet] ## 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)