--- title: "Create vCenter" method: POST path: "/vmware-vcenter" tags: ["vCenter"] --- # Create vCenter `POST /vmware-vcenter` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/vmware-vcenter` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new vCenter ## Request body - object - `data` VMwareVCenterCreateSchema, required: Create schema for VMwareVCenter model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this vCenter (a vCenter Server, or a standalone ESXi host). This is the join key — it must match the vmware.vcenter.name OTel resource attribute stamped by the OneUptime VMware Agent (VMWARE_VCENTER_NAME). Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `description` string: Friendly description for this vCenter. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `isArchived` boolean: Is this vCenter archived? Archived vCenters are hidden from lists but keep collecting telemetry. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `labels` object[]: Labels to group and filter by. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `id` string - `retainTelemetryDataForDays` number: Number of days to retain telemetry data for this vCenter. Leave blank to use the project-wide default. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `telemetryRetentionConfig` object: Per-pillar retention overrides for this vCenter (logs by severity, traces by status, metrics, profiles). Unset fields fall back to the vCenter default, then the project's retention settings. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `collectionMethod` 'Agent' | 'Probe': How this vCenter's data reaches OneUptime. Probe: one of your OneUptime probes logs in to vCenter with the read-only account saved here and collects it - no agent to install. Agent: the OneUptime VMware Agent you run sends it. Switching to Agent forgets the saved password. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `vcenterUrl` string: The HTTPS address of vCenter Server (or a standalone ESXi host) the probe connects to, such as https://vcsa.example.com. Stored as https://host[:port]; a path such as /ui or /sdk is dropped. Changing it asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `vcenterUsername` string: The vSphere user the probe logs in as, with its domain - such as oneuptime@vsphere.local. Give it the built-in Read-Only role on the top-level vCenter object, propagated to children. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `vcenterPassword` string, password: The password of the vCenter user. Write-only: encrypted at rest, never returned by the API, and sent only to the probe that collects this vCenter. Leave it out of an update to keep the saved one; changing the address, the probe or the trusted certificate needs it again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [No access - you don't have permission for this operation], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `collectionProbeId` string, uuid: ID of the OneUptime probe that collects this vCenter. Changing it asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `trustedCertificateFingerprint` string: The SHA-256 fingerprint of the one certificate the probe accepts from this vCenter, for a vCenter whose certificate is not from a public authority (vCenter's own VMCA certificate, by default). Empty: the certificate must be signed by an authority the probe's machine trusts. Verification is never skipped. Trusting a different certificate asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `collectionIntervalInMinutes` number: How often the probe collects this vCenter, in whole minutes from 1 to 60. Two minutes is the VMware agent's own default; collect large vCenters less often to go easier on vCenter. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] ## Response `201` Created successfully - object - `data` VMwareVCenterReadSchema: Read schema for VMwareVCenter model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this vCenter (a vCenter Server, or a standalone ESXi host). This is the join key — it must match the vmware.vcenter.name OTel resource attribute stamped by the OneUptime VMware Agent (VMWARE_VCENTER_NAME). Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `slug` string: 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 vCenter], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description for this vCenter. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `agentVersion` string: Version of the OneUptime VMware 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `lastSeenAt` object: When metrics were last received from this vCenter. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `datacenterCount` number: Cached count of vSphere datacenters reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries datacenter metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `clusterCount` number: Cached count of vSphere clusters reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries cluster metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `hostCount` number: Cached count of ESXi hosts reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries host metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `vmCount` number: Cached count of virtual machines (excluding VM templates) reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries virtual machine metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `poweredOnVmCount` number: Cached count of virtual machines inferred to be powered on (the vcenter receiver emits CPU metrics only for powered-on VMs). Rendered as 'VMs X/Y powered on' next to vmCount. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `datastoreCount` number: Cached count of datastores reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries datastore metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `resourcePoolCount` number: Cached count of resource pools reported through this vCenter. Written by the ingest snapshot scan; only updated when a batch carries resource pool metrics. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `datastoreCapacityBytes` number: Cached total capacity in bytes summed over every datastore reported through this vCenter (used + available vcenter.datastore.disk.usage). The denominator for the storage-used bar on the overview page. Stored as bigint. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `datastoreUsedBytes` number: Cached used space in bytes summed over every datastore reported through this vCenter (vcenter.datastore.disk.usage{disk_state=used}). Stored as bigint. 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 vCenter], Update: [Project Owner, Project Admin, Edit vCenter] - `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 vCenter], Update: [No access - you don't have permission for this operation] - `isArchived` boolean: Is this vCenter archived? Archived vCenters are hidden from lists but keep collecting telemetry. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `archivedAt` object: When was this vCenter 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 vCenter], 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 vCenter], 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 vCenter], 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 vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `id` string - `retainTelemetryDataForDays` number: Number of days to retain telemetry data for this vCenter. Leave blank to use the project-wide default. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `telemetryRetentionConfig` object: Per-pillar retention overrides for this vCenter (logs by severity, traces by status, metrics, profiles). Unset fields fall back to the vCenter default, then the project's retention settings. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `isAiInvestigationEnabled` boolean: When on, OneUptime AI runs read-only commands (govc about, ls, vm.info, host.info, events) on this vCenter, through its VMware AI agent, while investigating incidents and alerts linked to it, and uses their output, with secret values redacted, as evidence. Nothing is ever changed by an investigation. On by default. Anyone who may edit the vCenter can turn it on or off. 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 vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `aiRemediationMode` 'Disabled' | 'RequireApproval' | 'Automatic' | 'BypassApproval': Disabled: AI never proposes or runs a change on this vCenter. RequireApproval: AI composes a command plan and a human approves it with one click before anything runs. Automatic: safe changes (SafeWrite) run without a human; a riskier change is proposed for approval unless the vCenter's allowlist names its exact shape. BypassApproval: every change the policy allows — safe AND riskier — runs on its own, except what always needs a human. In EVERY mode: Denied commands never run, commands the policy marks requiresHuman always ask, and the agent itself refuses every write unless it was started with ONEUPTIME_AI_ALLOW_WRITES=true (and then only on the targets ONEUPTIME_AI_WRITE_TARGETS allows, never its protected targets). Anyone who may edit the vCenter can lower the mode; raising it needs Project Owner, Project Admin or Edit AI Rule. 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 vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `aiCommandAllowlist` object: Optional JSON array of command patterns that Automatic mode may run on this vCenter without approval even though they are riskier changes. Each pattern is one command line for this vCenter's agent (govc) and is compared with the command word by word: * stands for exactly one word (a name, an id), never for extra words or flags, and every flag the command uses must be written out in the pattern. At most 50 patterns of at most 500 characters each; a pattern that is not one valid write command for this vCenter is refused. Destructive commands (Denied tier) never run regardless, and a command that always needs a human still asks. Adding a pattern needs Project Owner, Project Admin or Edit AI Rule; anyone who may edit the vCenter can remove patterns or clear the list. 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 vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `aiAccessLastVerifiedAt` object: When a command from OneUptime AI last succeeded on this vCenter through its VMware AI agent. Set by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `aiAccessLastError` string: The most recent failure OneUptime AI hit while running a command on this vCenter, kept until the next successful command. Set by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `aiAccessConfiguredAt` object: When OneUptime AI access to this vCenter was first configured by anyone saving an AI access setting. Set by the server; never cleared, so a VMware AI agent that registers later never overwrites a setting an operator chose. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionMethod` 'Agent' | 'Probe': How this vCenter's data reaches OneUptime. Probe: one of your OneUptime probes logs in to vCenter with the read-only account saved here and collects it - no agent to install. Agent: the OneUptime VMware Agent you run sends it. Switching to Agent forgets the saved password. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `vcenterUrl` string: The HTTPS address of vCenter Server (or a standalone ESXi host) the probe connects to, such as https://vcsa.example.com. Stored as https://host[:port]; a path such as /ui or /sdk is dropped. Changing it asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `vcenterUsername` string: The vSphere user the probe logs in as, with its domain - such as oneuptime@vsphere.local. Give it the built-in Read-Only role on the top-level vCenter object, propagated to children. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `isVCenterPasswordSet` boolean: Whether a vCenter password is saved. Set by the server from the password itself. 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 vCenter], Update: [No access - you don't have permission for this operation] - `vcenterCredentialsUpdatedAt` object: When the vCenter user name or password was last changed. Set by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionProbeId` string, uuid: ID of the OneUptime probe that collects this vCenter. Changing it asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `trustedCertificateFingerprint` string: The SHA-256 fingerprint of the one certificate the probe accepts from this vCenter, for a vCenter whose certificate is not from a public authority (vCenter's own VMCA certificate, by default). Empty: the certificate must be signed by an authority the probe's machine trusts. Verification is never skipped. Trusting a different certificate asks for the password again. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `collectionIntervalInMinutes` number: How often the probe collects this vCenter, in whole minutes from 1 to 60. Two minutes is the VMware agent's own default; collect large vCenters less often to go easier on vCenter. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create vCenter], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read vCenter], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit vCenter] - `collectionStatus` 'Pending' | 'Succeeded' | 'Failed': Where probe collection stands: Pending (the probe has not tried the current settings yet), Succeeded or Failed. Written by the server and the probe. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionErrorCode` 'InvalidAddress' | 'AddressNotAllowed' | 'AddressNotFound' | 'ConnectionRefused' | 'ConnectionTimedOut' | 'ConnectionFailed' | 'TlsFailed' | 'UntrustedCertificate' | 'CertificateChanged' | 'NotVSphere' | 'InvalidLogin' | 'NoPermission' | 'ApiError' | 'TimedOut' | 'PayloadTooLarge' | 'ProbeNotAllowed' | 'ProbeNotAvailable' | 'Internal': Why the last collection failed, as a code the dashboard turns into a next step (InvalidLogin, UntrustedCertificate, ConnectionTimedOut, ...). Written by the probe. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionError` string: What went wrong in the last collection, in words. Written by the probe. 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 vCenter], Update: [No access - you don't have permission for this operation] - `presentedCertificate` object: The certificate vCenter presented when the last collection did not trust it: its SHA-256 fingerprint, subject, issuer and validity, so a person can check it and trust exactly that certificate. Written by the probe. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionSummary` object: What the last successful collection found: vCenter's product and version, and how many datacenters, clusters, hosts, virtual machines, datastores and resource pools it reported. Written by the probe. 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 vCenter], Update: [No access - you don't have permission for this operation] - `nextCollectionAt` object: When the probe collects this vCenter next. Written by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `lastCollectionAt` object: When the probe last tried to collect this vCenter, whether it worked or not. Written by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `lastSuccessfulCollectionAt` object: When the probe last collected this vCenter successfully. Written by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] - `collectionSettingsVersion` number: Counts changes to the probe collection settings, so a report from a collection that started before a change is not shown as the current status. Written by the server. 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 vCenter], Update: [No access - you don't have permission for this operation] ## 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. - `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)