Cloud Resource
List Cloud Resource
Endpoint to list all Cloud Resource items
post/cloud-resource/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,
"resourceIdentifier": true,
"cloudPlatform": true,
"cloudProvider": true,
"cloudRegion": 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": "AWS ECS · us-east-1 · 123456789012",
"slug": "example-slug-value",
"description": "This is an example of longer text content that might be stored in this field.",
"resourceIdentifier": "Example short text",
"cloudPlatform": "Example short text",
"cloudProvider": "Example short text",
"cloudRegion": "Example short text",
"cloudAccountId": "Example short text",
"cloudResourceKind": "resource",
"cloudResourceType": "Microsoft.Compute/virtualMachines",
"providerResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg-prod/providers/Microsoft.Compute/virtualMachines/vm-prod-01",
"cloudResourceGroup": "rg-prod",
"telemetryAttributes": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudTags": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudProperties": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudRelationships": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudEndpoints": {
"key": "value",
"nested": {
"data": 123
}
},
"inventoriedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"cloudReadings": {
"key": "value",
"nested": {
"data": 123
}
},
"cloudReadingsAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"healthSeverity": "Example short text",
"cloudConnectionId": "123e4567-e89b-12d3-a456-426614174000",
"runtimeName": "Example short text",
"runtimeVersion": "Example short text",
"otelCollectorStatus": "Example short text",
"agentVersion": "Example short text",
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"labels": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"retainTelemetryDataForDays": 42,
"telemetryRetentionConfig": {
"key": "value",
"nested": {
"data": 123
}
},
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"isArchived": true,
"archivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"archivedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"autoArchivedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"deletedByUserId": "123e4567-e89b-12d3-a456-426614174000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.