OpenStack Cloud
List OpenStack Cloud
Endpoint to list all OpenStack Cloud items
post/openstack-cloud/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,
"otelCollectorStatus": true,
"agentVersion": true,
"collectionMethod": true,
"endpointInterface": 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",
"slug": "example-slug-value",
"description": "Production OpenStack cloud running in US East region",
"otelCollectorStatus": "connected",
"agentVersion": "1.0.0",
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"regionCount": 42,
"availabilityZoneCount": 42,
"hypervisorCount": 42,
"instanceCount": 42,
"activeInstanceCount": 42,
"volumeCount": 42,
"networkCount": 42,
"routerCount": 42,
"floatingIpCount": 42,
"projectCount": 42,
"serviceCount": 42,
"downServiceCount": 42,
"vcpuCapacity": 42,
"vcpuAllocated": 42,
"memoryCapacityBytes": 1000000,
"memoryAllocatedBytes": 1000000,
"storageCapacityBytes": 1000000,
"storageUsedBytes": 1000000,
"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
}
},
"collectionMethod": "Probe",
"authUrl": "https://keystone.example.com:5000",
"endpointInterface": "public",
"collectionRegions": {
"key": "value",
"nested": {
"data": 123
}
},
"credentialKind": "applicationCredential",
"applicationCredentialId": "aa912b9a1d8446c3a5b5b5a1f0a4c9e1",
"keystoneUsername": "oneuptime-reader",
"userDomainName": "Default",
"projectName": "monitoring",
"projectDomainName": "Default",
"isCredentialSet": true,
"credentialsUpdatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectionProbeId": "123e4567-e89b-12d3-a456-426614174000",
"trustedCertificateFingerprints": {
"key": "value",
"nested": {
"data": 123
}
},
"collectionIntervalInMinutes": 42,
"collectionOptions": {
"key": "value",
"nested": {
"data": 123
}
},
"instanceMetricsOptions": {
"key": "value",
"nested": {
"data": 123
}
},
"capacitySnapshot": {
"key": "value",
"nested": {
"data": 123
}
},
"spendSnapshot": {
"key": "value",
"nested": {
"data": 123
}
},
"usageReadAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"priceList": {
"key": "value",
"nested": {
"data": 123
}
},
"collectionStatus": "Succeeded",
"collectionErrorCode": "InvalidCredential",
"collectionError": "This is an example of longer text content that might be stored in this field.",
"presentedCertificate": {
"key": "value",
"nested": {
"data": 123
}
},
"collectionSummary": {
"key": "value",
"nested": {
"data": 123
}
},
"nextCollectionAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastCollectionAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"lastSuccessfulCollectionAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectionSettingsVersion": 42,
"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"
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.