vCenter
Get vCenter
Endpoint to retrieve a single vCenter by ID
post/vmware-vcenter/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the vCenter to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": true,
"name": true,
"otelCollectorStatus": true,
"agentVersion": true,
"aiRemediationMode": true,
"collectionMethod": true
}
}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": "vcenter-prod",
"slug": "example-slug-value",
"description": "Production vCenter Server for the US East datacenter",
"otelCollectorStatus": "connected",
"agentVersion": "1.0.0",
"lastSeenAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"datacenterCount": 42,
"clusterCount": 42,
"hostCount": 42,
"vmCount": 42,
"poweredOnVmCount": 42,
"datastoreCount": 42,
"resourcePoolCount": 42,
"datastoreCapacityBytes": 1000000,
"datastoreUsedBytes": 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
}
},
"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"
},
"collectionMethod": "Probe",
"vcenterUrl": "https://vcsa.example.com",
"vcenterUsername": "oneuptime@vsphere.local",
"isVCenterPasswordSet": true,
"vcenterCredentialsUpdatedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"collectionProbeId": "123e4567-e89b-12d3-a456-426614174000",
"trustedCertificateFingerprint": "3A:7F:12:9C:4B:D0:55:E1:08:6A:B2:C3:91:F4:27:8E:6D:0B:A5:C8:13:4E:F9:72:B6:5D:0A:E3:29:C1:7B:44",
"collectionIntervalInMinutes": 42,
"collectionStatus": "Succeeded",
"collectionErrorCode": "InvalidLogin",
"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
}
}Changes
No recorded changes to this operation across all 1 revision of this API.