Host
List Host
Endpoint to list all Host items
post/host/get-list
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"query": {
"createdAt": {
"_type": "GreaterThan",
"value": "2026-01-01T00:00:00.000Z"
},
"name": {
"_type": "Search",
"value": "example"
}
},
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"hostIdentifier": true,
"otelCollectorStatus": true,
"agentVersion": true,
"osType": true
},
"sort": {
"createdAt": "DESC"
}
}Response
Successful response
Example response
{
"data": [
{
"_id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"updatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"version": 42,
"projectId": "123e4567-e89b-12d3-a456-426614174000",
"name": "production-host-1",
"slug": "example-slug-value",
"description": "Production host running in US East region",
"hostIdentifier": "host-prod-1",
"otelCollectorStatus": "connected",
"agentVersion": "1.0.0",
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"osType": "linux",
"osVersion": "Ubuntu 22.04",
"hostId": "ec2-instance-id-or-machine-id",
"hostArch": "amd64",
"hostType": "t3.medium",
"hostIpAddresses": "192.168.1.42, 10.0.0.5",
"cpuCores": 42,
"totalMemoryBytes": 1000000,
"processCount": 42,
"containerRuntime": "docker",
"dockerHostId": "123e4567-e89b-12d3-a456-426614174000",
"kubernetesClusterId": "123e4567-e89b-12d3-a456-426614174000",
"proxmoxClusterId": "123e4567-e89b-12d3-a456-426614174000",
"openStackCloudId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"deletedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"retainTelemetryDataForDays": 42,
"telemetryRetentionConfig": {
"key": "value",
"nested": {
"data": 123
}
},
"deploymentEnvironment": "Example short text",
"runtimeName": "Example short text",
"runtimeVersion": "Example short text",
"cloudProvider": "Example short text",
"cloudPlatform": "Example short text",
"cloudRegion": "Example short text",
"cloudAccountId": "Example short text",
"isAiInvestigationEnabled": true,
"aiRemediationMode": "RequireApproval",
"aiCommandAllowlist": {
"key": "value",
"nested": {
"data": 123
}
},
"aiAccessLastVerifiedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"aiAccessLastError": "This is an example of longer text content that might be stored in this field.",
"aiAccessConfiguredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectorInstanceUid": "Example short text",
"collectorLastContactAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectorRegisteredAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectorConfigId": "123e4567-e89b-12d3-a456-426614174000",
"isCollectorConfigPinned": true,
"collectorConfigVersionId": "123e4567-e89b-12d3-a456-426614174000",
"collectorConfigHash": "Example short text",
"collectorConfigStatus": "waiting",
"collectorConfigError": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"collectorFailedConfigHash": "Example short text",
"isCollectorHealthy": true,
"collectorHealthError": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"collectorHostFeatures": "Example short text",
"latestCpuPercent": 42,
"latestMemoryPercent": 42,
"latestSwapPercent": 42,
"latestDiskPercent": 42,
"latestDiskMountpoint": "/var",
"latestInodesPercent": 42,
"latestInodesMountpoint": "/var",
"latestLoadAverage15m": 42,
"bootedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"failedSystemdUnitCount": 42,
"failedSystemdUnits": {
"key": "value",
"nested": {
"data": 123
}
},
"readingsUpdatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.