{ "source": "vmware/vcf-api-specs specifications/vsphere/openapi/automation/vcenter.yaml", "openapi": "3.0.3", "title": "vSphere Automation API", "version": "9.1.0.0", "method_count": 1183, "methods": { "DELETE /api/appliance/local-accounts/{username}": { "verb": "DELETE", "path": "/api/appliance/local-accounts/{username}", "query_fields": [], "path_fields": [ { "name": "username", "type": "string", "optional": false, "description": "User login name", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.LocalAccounts_delete" ] }, "DELETE /api/appliance/networking/proxy/{protocol}": { "verb": "DELETE", "path": "/api/appliance/networking/proxy/{protocol}", "query_fields": [], "path_fields": [ { "name": "protocol", "type": "string", "optional": false, "description": "ID whose proxy is to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Proxy_delete" ] }, "DELETE /api/appliance/recovery/backup/schedules/{schedule}": { "verb": "DELETE", "path": "/api/appliance/recovery/backup/schedules/{schedule}", "query_fields": [], "path_fields": [ { "name": "schedule", "type": "string", "optional": false, "description": "Identifier of the schedule", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_delete" ] }, "DELETE /api/appliance/support-bundle/{id}": { "verb": "DELETE", "path": "/api/appliance/support-bundle/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "The parameter must be an identifier for the resource type: `com.vmware.appliance.supportbundle`.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.SupportBundle_delete" ] }, "DELETE /api/appliance/tls/manual-parameters/services/{service}": { "verb": "DELETE", "path": "/api/appliance/tls/manual-parameters/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "for which the configured TLS parameters has to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.ManualParameters.Services_delete$Task" ] }, "DELETE /api/appliance/update/staged": { "verb": "DELETE", "path": "/api/appliance/update/staged", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Staged_delete" ] }, "DELETE /api/cis/tagging/category/{categoryId}": { "verb": "DELETE", "path": "/api/cis/tagging/category/{categoryId}", "query_fields": [], "path_fields": [ { "name": "categoryId", "type": "string", "optional": false, "description": "The identifier of category to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Category_delete" ] }, "DELETE /api/cis/tagging/tag/{tagId}": { "verb": "DELETE", "path": "/api/cis/tagging/tag/{tagId}", "query_fields": [], "path_fields": [ { "name": "tagId", "type": "string", "optional": false, "description": "The identifier of the input tag.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Tag_delete" ] }, "DELETE /api/content/library/item/download-session/{downloadSessionId}": { "verb": "DELETE", "path": "/api/content/library/item/download-session/{downloadSessionId}", "query_fields": [], "path_fields": [ { "name": "downloadSessionId", "type": "string", "optional": false, "description": "Identifier of the download session to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.DownloadSession_delete" ] }, "DELETE /api/content/library/item/update-session/{updateSessionId}": { "verb": "DELETE", "path": "/api/content/library/item/update-session/{updateSessionId}", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifer of the update session to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.UpdateSession_delete" ] }, "DELETE /api/content/library/item/update-session/{updateSessionId}/file/{fileName}": { "verb": "DELETE", "path": "/api/content/library/item/update-session/{updateSessionId}/file/{fileName}", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session.", "enum": [], "example": "example" }, { "name": "fileName", "type": "string", "optional": false, "description": "Name of the file to be removed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Updatesession.File_remove" ] }, "DELETE /api/content/library/item/{libraryItemId}": { "verb": "DELETE", "path": "/api/content/library/item/{libraryItemId}", "query_fields": [], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item_delete" ] }, "DELETE /api/content/library/{libraryId}": { "verb": "DELETE", "path": "/api/content/library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the library to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library_delete" ] }, "DELETE /api/content/library/{library}/subscriptions/{subscription}": { "verb": "DELETE", "path": "/api/content/library/{library}/subscriptions/{subscription}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier of the published library.", "enum": [], "example": "example" }, { "name": "subscription", "type": "string", "optional": false, "description": "Subscription identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Subscriptions_delete" ] }, "DELETE /api/content/library/{library}/usages/{usage}": { "verb": "DELETE", "path": "/api/content/library/{library}/usages/{usage}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "The identifier of the content library for which the usage needs to be removed.", "enum": [], "example": "example" }, { "name": "usage", "type": "string", "optional": false, "description": "The usage to be removed from the content library.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Usages_remove" ] }, "DELETE /api/content/local-library/{libraryId}": { "verb": "DELETE", "path": "/api/content/local-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the local library to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.LocalLibrary_delete" ] }, "DELETE /api/content/subscribed-library/{libraryId}": { "verb": "DELETE", "path": "/api/content/subscribed-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the subscribed library to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.SubscribedLibrary_delete" ] }, "DELETE /api/content/trusted-certificates/{certificate}": { "verb": "DELETE", "path": "/api/content/trusted-certificates/{certificate}", "query_fields": [], "path_fields": [ { "name": "certificate", "type": "string", "optional": false, "description": "id of the trusted certificate.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.TrustedCertificates_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Drafts_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AddOn_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.AddOn_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.Components_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.HardwareSupport_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.RemovedComponents_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.Components_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.HardwareSupport_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.RemovedComponents_delete" ] }, "DELETE /api/esx/settings/clusters/{cluster}/software/solutions/{solution}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Solutions_delete$Task" ] }, "DELETE /api/esx/settings/clusters/{cluster}/vms/solutions/{solution}": { "verb": "DELETE", "path": "/api/esx/settings/clusters/{cluster}/vms/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the VM solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.Solutions_delete$Task" ] }, "DELETE /api/esx/settings/depots/offline/{depot}": { "verb": "DELETE", "path": "/api/esx/settings/depots/offline/{depot}", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier of the depot to be removed.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "force", "type": "boolean", "description": "force", "optional": true, "enum": [], "example": false } ], "body_example": { "force": false }, "operation_ids": [ "Esx.Settings.Depots.Offline_delete", "Esx.Settings.Depots.Offline_delete$Task" ] }, "DELETE /api/esx/settings/depots/online/{depot}": { "verb": "DELETE", "path": "/api/esx/settings/depots/online/{depot}", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier of the depot to be removed.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "force", "type": "boolean", "description": "force", "optional": true, "enum": [], "example": false } ], "body_example": { "force": false }, "operation_ids": [ "Esx.Settings.Depots.Online_delete", "Esx.Settings.Depots.Online_delete$Task" ] }, "DELETE /api/esx/settings/depots/umds": { "verb": "DELETE", "path": "/api/esx/settings/depots/umds", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Umds_delete", "Esx.Settings.Depots.Umds_delete$Task" ] }, "DELETE /api/esx/settings/hosts/{host}/software/drafts/{draft}": { "verb": "DELETE", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts_delete" ] }, "DELETE /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on": { "verb": "DELETE", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.AddOn_delete" ] }, "DELETE /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.Components_delete" ] }, "DELETE /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the standalone host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.RemovedComponents_delete" ] }, "DELETE /api/esx/settings/hosts/{host}/software/solutions/{solution}": { "verb": "DELETE", "path": "/api/esx/settings/hosts/{host}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Solutions_delete$Task" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/add-on": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AddOn_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.AddOn_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.Components_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.HardwareSupport_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.RemovedComponents_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.Components_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/hardware-support": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.HardwareSupport_delete" ] }, "DELETE /api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.RemovedComponents_delete" ] }, "DELETE /api/esx/settings/repository/software/{softwareSpec}": { "verb": "DELETE", "path": "/api/esx/settings/repository/software/{softwareSpec}", "query_fields": [], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "The identifier of the software specification in the repository.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software_delete" ] }, "DELETE /api/session": { "verb": "DELETE", "path": "/api/session", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Session_delete" ] }, "DELETE /api/stats/acq-specs/{id}": { "verb": "DELETE", "path": "/api/stats/acq-specs/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Acquisition specification ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.AcqSpecs_delete" ] }, "DELETE /api/vcenter/authorization/permissions/{permission}": { "verb": "DELETE", "path": "/api/vcenter/authorization/permissions/{permission}", "query_fields": [], "path_fields": [ { "name": "permission", "type": "string", "optional": false, "description": "the unique identifier of the permission in the vCenter Server.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Permissions_delete" ] }, "DELETE /api/vcenter/authorization/roles/{role}": { "verb": "DELETE", "path": "/api/vcenter/authorization/roles/{role}", "query_fields": [], "path_fields": [ { "name": "role", "type": "string", "optional": false, "description": "the unique identifier of the role in the vCenter Server.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Roles_delete" ] }, "DELETE /api/vcenter/authorization/vt-containers/mappings/{mapping}": { "verb": "DELETE", "path": "/api/vcenter/authorization/vt-containers/mappings/{mapping}", "query_fields": [], "path_fields": [ { "name": "mapping", "type": "string", "optional": false, "description": "The mapping identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.VtContainers.Mappings_delete" ] }, "DELETE /api/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}": { "verb": "DELETE", "path": "/api/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}", "query_fields": [], "path_fields": [ { "name": "chain", "type": "string", "optional": false, "description": "Unique identifier for a trusted root cert chain.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.TrustedRootChains_delete" ] }, "DELETE /api/vcenter/compute/policies/{policy}": { "verb": "DELETE", "path": "/api/vcenter/compute/policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier of the policy to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies_delete" ] }, "DELETE /api/vcenter/consumption-domains/zones/{zone}": { "verb": "DELETE", "path": "/api/vcenter/consumption-domains/zones/{zone}", "query_fields": [], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones_delete" ] }, "DELETE /api/vcenter/content/registries/harbor/{registry}": { "verb": "DELETE", "path": "/api/vcenter/content/registries/harbor/{registry}", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor_delete" ] }, "DELETE /api/vcenter/content/registries/harbor/{registry}/projects/{project}": { "verb": "DELETE", "path": "/api/vcenter/content/registries/harbor/{registry}/projects/{project}", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" }, { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Harbor project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor.Projects_delete" ] }, "DELETE /api/vcenter/crypto-manager/kms/providers/{provider}": { "verb": "DELETE", "path": "/api/vcenter/crypto-manager/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CryptoManager.Kms.Providers_delete" ] }, "DELETE /api/vcenter/datacenter/{datacenter}": { "verb": "DELETE", "path": "/api/vcenter/datacenter/{datacenter}", "query_fields": [ { "name": "force", "type": "boolean", "optional": true, "description": "If true, delete the datacenter even if it is not empty.", "enum": [], "example": false } ], "path_fields": [ { "name": "datacenter", "type": "string", "optional": false, "description": "Identifier of the datacenter to be deleted.", "enum": [], "example": "datacenter-21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datacenter_delete" ] }, "DELETE /api/vcenter/guest/customization-specs/{name}": { "verb": "DELETE", "path": "/api/vcenter/guest/customization-specs/{name}", "query_fields": [], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "The name of the customization specification that needs to be deleted.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_delete" ] }, "DELETE /api/vcenter/host/{host}": { "verb": "DELETE", "path": "/api/vcenter/host/{host}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host to be deleted.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host_delete" ] }, "DELETE /api/vcenter/identity/providers/{provider}": { "verb": "DELETE", "path": "/api/vcenter/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "the identifier of the provider to delete", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Identity.Providers_delete" ] }, "DELETE /api/vcenter/lcm/discovery/associated-products/{product}": { "verb": "DELETE", "path": "/api/vcenter/lcm/discovery/associated-products/{product}", "query_fields": [], "path_fields": [ { "name": "product", "type": "string", "optional": false, "description": "An id of the product to be removed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Discovery.AssociatedProducts_delete" ] }, "DELETE /api/vcenter/namespace-management/clusters/{cluster}/networks/{network}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the vSphere Namespaces network.", "enum": [], "example": "network-41" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_delete" ] }, "DELETE /api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster backing this Supervisor.", "enum": [], "example": "domain-c21" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.ClusterSupervisorServices_delete" ] }, "DELETE /api/vcenter/namespace-management/infrastructure-policies/{policy}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/infrastructure-policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier for the policy to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.InfrastructurePolicies_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisor-services/{supervisorService}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier of the Supervisor Service.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Identifier of the version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.Versions_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which the container image registry is created.", "enum": [], "example": "example" }, { "name": "containerImageRegistry", "type": "string", "optional": false, "description": "Identifier for the container image registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ContainerImageRegistries_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the identifier of the Supervisor which is associated with the identity provider being removed.", "enum": [], "example": "example" }, { "name": "provider", "type": "string", "optional": false, "description": "the identifier for the identity provider that is to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" }, { "name": "managementService", "type": "string", "optional": false, "description": "Identifier of the Management Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ManagementServices_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the remote endpoint is being deleted.", "enum": [], "example": "example" }, { "name": "remoteEndpoint", "type": "string", "optional": false, "description": "identifier for the remote endpoint that is being deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the Supervisor network.", "enum": [], "example": "network-41" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_delete" ] }, "DELETE /api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor", "enum": [], "example": "example" }, { "name": "zone", "type": "string", "optional": false, "description": "The ID of the vSphere Zone to remove from the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Zones.Bindings_delete" ] }, "DELETE /api/vcenter/namespace-management/virtual-machine-classes/{vm_class}": { "verb": "DELETE", "path": "/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}", "query_fields": [], "path_fields": [ { "name": "vm_class", "type": "string", "optional": false, "description": "Identifier for the VM class.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.VirtualMachineClasses_delete" ] }, "DELETE /api/vcenter/namespaces/instances/{namespace}": { "verb": "DELETE", "path": "/api/vcenter/namespaces/instances/{namespace}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances_delete" ] }, "DELETE /api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}": { "verb": "DELETE", "path": "/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}", "query_fields": [ { "name": "type", "type": "string", "optional": false, "description": "The type of subject (USER or GROUP).", "enum": [], "example": "example" } ], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "domain", "type": "string", "optional": false, "description": "The domain of the subject.", "enum": [], "example": "example" }, { "name": "subject", "type": "string", "optional": false, "description": "The principal for this operation.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Access_delete" ] }, "DELETE /api/vcenter/namespaces/instances/{namespace}/zones/{zone}": { "verb": "DELETE", "path": "/api/vcenter/namespaces/instances/{namespace}/zones/{zone}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "zone", "type": "string", "optional": false, "description": "Identifier for the zone to be removed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances.Zones_delete" ] }, "DELETE /api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}": { "verb": "DELETE", "path": "/api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier of the namespace.", "enum": [], "example": "example" }, { "name": "accessGrant", "type": "string", "optional": false, "description": "Identifier of the Access Grant.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.ManagementServices.AccessGrants_delete" ] }, "DELETE /api/vcenter/phm/hardware-support-managers/{key}": { "verb": "DELETE", "path": "/api/vcenter/phm/hardware-support-managers/{key}", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key for the HSM to be updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers_delete" ] }, "DELETE /api/vcenter/resource-pool/{resourcePool}": { "verb": "DELETE", "path": "/api/vcenter/resource-pool/{resourcePool}", "query_fields": [], "path_fields": [ { "name": "resourcePool", "type": "string", "optional": false, "description": "Identifier of the resource pool to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ResourcePool_delete" ] }, "DELETE /api/vcenter/trusted-infrastructure/attestation/services/{service}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/attestation/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "the Attestation Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Attestation.Services_delete" ] }, "DELETE /api/vcenter/trusted-infrastructure/kms/services/{service}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/kms/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "the Key Provider Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Kms.Services_delete" ] }, "DELETE /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "version", "type": "string", "optional": false, "description": "The ESX base image version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Os.Esx.BaseImages_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "name", "type": "string", "optional": false, "description": "The CA certificate name.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.CaCertificates_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "name", "type": "string", "optional": false, "description": "The endorsement key name.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.EndorsementKeys_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the Trust Authority Cluster to configure.", "enum": [], "example": "domain-c21" }, { "name": "profile", "type": "string", "optional": false, "description": "The ID of the connection profile to modify.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.ConsumerPrincipals_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.ServicesAppliedConfig_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "the unique ID of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "service", "type": "string", "optional": false, "description": "the registered Attestation Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.Services_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.ServicesAppliedConfig_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "the unique ID of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "service", "type": "string", "optional": false, "description": "the registered Key Provider Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.Services_delete$Task" ] }, "DELETE /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config": { "verb": "DELETE", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.ServicesAppliedConfig_delete$Task" ] }, "DELETE /api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}": { "verb": "DELETE", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" }, { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the checked out virtual machine to delete.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.CheckOuts_delete" ] }, "DELETE /api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}": { "verb": "DELETE", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Version of the library item to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.Versions_delete" ] }, "DELETE /api/vcenter/vm/{vm}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VM_delete" ] }, "DELETE /api/vcenter/vm/{vm}/data-sets/{dataSet}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}", "query_fields": [ { "name": "force", "type": "boolean", "optional": true, "description": "If true, delete the data set even if it is not empty.", "enum": [], "example": false } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets_delete" ] }, "DELETE /api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set.", "enum": [], "example": "example" }, { "name": "key", "type": "string", "optional": false, "description": "The key of the entry to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets.Entries_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual NVMe adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Nvme_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual SATA adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Sata_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual SCSI adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Scsi_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "cdrom", "type": "string", "optional": false, "description": "Virtual CD-ROM device identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/disk/{disk}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/disk/{disk}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "disk", "type": "string", "optional": false, "description": "Virtual disk identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Disk_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/ethernet/{nic}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/ethernet/{nic}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "nic", "type": "string", "optional": false, "description": "Virtual Ethernet adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/floppy/{floppy}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/floppy/{floppy}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "floppy", "type": "string", "optional": false, "description": "Virtual floppy drive identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/parallel/{port}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/parallel/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual parallel port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_delete" ] }, "DELETE /api/vcenter/vm/{vm}/hardware/serial/{port}": { "verb": "DELETE", "path": "/api/vcenter/vm/{vm}/hardware/serial/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual serial port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_delete" ] }, "GET /api/appliance/access/consolecli": { "verb": "GET", "path": "/api/appliance/access/consolecli", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Access.Consolecli_get" ] }, "GET /api/appliance/access/dcui": { "verb": "GET", "path": "/api/appliance/access/dcui", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Access.Dcui_get" ] }, "GET /api/appliance/access/shell": { "verb": "GET", "path": "/api/appliance/access/shell", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Access.Shell_get" ] }, "GET /api/appliance/access/ssh": { "verb": "GET", "path": "/api/appliance/access/ssh", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Access.Ssh_get" ] }, "GET /api/appliance/health/applmgmt": { "verb": "GET", "path": "/api/appliance/health/applmgmt", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Applmgmt_get" ] }, "GET /api/appliance/health/database": { "verb": "GET", "path": "/api/appliance/health/database", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Database_get" ] }, "GET /api/appliance/health/database-storage": { "verb": "GET", "path": "/api/appliance/health/database-storage", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Databasestorage_get" ] }, "GET /api/appliance/health/load": { "verb": "GET", "path": "/api/appliance/health/load", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Load_get" ] }, "GET /api/appliance/health/mem": { "verb": "GET", "path": "/api/appliance/health/mem", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Mem_get" ] }, "GET /api/appliance/health/settings": { "verb": "GET", "path": "/api/appliance/health/settings", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.HealthCheckSettings_get" ] }, "GET /api/appliance/health/software-packages": { "verb": "GET", "path": "/api/appliance/health/software-packages", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Softwarepackages_get" ] }, "GET /api/appliance/health/storage": { "verb": "GET", "path": "/api/appliance/health/storage", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Storage_get" ] }, "GET /api/appliance/health/swap": { "verb": "GET", "path": "/api/appliance/health/swap", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.Swap_get" ] }, "GET /api/appliance/health/system": { "verb": "GET", "path": "/api/appliance/health/system", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.System_get" ] }, "GET /api/appliance/health/system/lastcheck": { "verb": "GET", "path": "/api/appliance/health/system/lastcheck", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health.System_lastcheck" ] }, "GET /api/appliance/health/{item}/messages": { "verb": "GET", "path": "/api/appliance/health/{item}/messages", "query_fields": [], "path_fields": [ { "name": "item", "type": "string", "optional": false, "description": "ID of the data item", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Health_messages" ] }, "GET /api/appliance/infraprofile/configs": { "verb": "GET", "path": "/api/appliance/infraprofile/configs", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Infraprofile.Configs_list" ] }, "GET /api/appliance/local-accounts": { "verb": "GET", "path": "/api/appliance/local-accounts", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.LocalAccounts_list" ] }, "GET /api/appliance/local-accounts/global-policy": { "verb": "GET", "path": "/api/appliance/local-accounts/global-policy", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.LocalAccounts.Policy_get" ] }, "GET /api/appliance/local-accounts/{username}": { "verb": "GET", "path": "/api/appliance/local-accounts/{username}", "query_fields": [], "path_fields": [ { "name": "username", "type": "string", "optional": false, "description": "User login name", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.LocalAccounts_get" ] }, "GET /api/appliance/logging/forwarding": { "verb": "GET", "path": "/api/appliance/logging/forwarding", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Logging.Forwarding_get" ] }, "GET /api/appliance/logging/liagent/log-collection": { "verb": "GET", "path": "/api/appliance/logging/liagent/log-collection", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Logging.Liagent.LogCollection_get" ] }, "GET /api/appliance/monitoring": { "verb": "GET", "path": "/api/appliance/monitoring", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Monitoring_list" ] }, "GET /api/appliance/monitoring/query": { "verb": "GET", "path": "/api/appliance/monitoring/query", "query_fields": [ { "name": "item", "type": "object", "optional": false, "description": "MonitoredItemDataRequest Structure", "enum": [], "example": { "end_time": "example", "function": "example", "interval": "example", "start_time": "example" } }, { "name": "names", "type": "array", "optional": false, "description": "monitored item IDs Ex: CPU, MEMORY", "enum": [], "example": [ "web-01" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Monitoring_query" ] }, "GET /api/appliance/monitoring/{statId}": { "verb": "GET", "path": "/api/appliance/monitoring/{statId}", "query_fields": [], "path_fields": [ { "name": "statId", "type": "string", "optional": false, "description": "statistic item id", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Monitoring_get" ] }, "GET /api/appliance/networking": { "verb": "GET", "path": "/api/appliance/networking", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking_get" ] }, "GET /api/appliance/networking/dns/domains": { "verb": "GET", "path": "/api/appliance/networking/dns/domains", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Dns.Domains_list" ] }, "GET /api/appliance/networking/dns/hostname": { "verb": "GET", "path": "/api/appliance/networking/dns/hostname", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Dns.Hostname_get" ] }, "GET /api/appliance/networking/dns/servers": { "verb": "GET", "path": "/api/appliance/networking/dns/servers", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Dns.Servers_get" ] }, "GET /api/appliance/networking/firewall/inbound": { "verb": "GET", "path": "/api/appliance/networking/firewall/inbound", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Firewall.Inbound_get" ] }, "GET /api/appliance/networking/interfaces": { "verb": "GET", "path": "/api/appliance/networking/interfaces", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Interfaces_list" ] }, "GET /api/appliance/networking/interfaces/{interface_name}": { "verb": "GET", "path": "/api/appliance/networking/interfaces/{interface_name}", "query_fields": [], "path_fields": [ { "name": "interface_name", "type": "string", "optional": false, "description": "Network interface, for example, \"nic0\".", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Interfaces_get" ] }, "GET /api/appliance/networking/interfaces/{interface_name}/ipv4": { "verb": "GET", "path": "/api/appliance/networking/interfaces/{interface_name}/ipv4", "query_fields": [], "path_fields": [ { "name": "interface_name", "type": "string", "optional": false, "description": "The Network interface to query, for example, \"nic0\".", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Interfaces.Ipv4_get" ] }, "GET /api/appliance/networking/interfaces/{interface_name}/ipv6": { "verb": "GET", "path": "/api/appliance/networking/interfaces/{interface_name}/ipv6", "query_fields": [], "path_fields": [ { "name": "interface_name", "type": "string", "optional": false, "description": "Network interface to query, for example, \"nic0\".", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Interfaces.Ipv6_get" ] }, "GET /api/appliance/networking/noproxy": { "verb": "GET", "path": "/api/appliance/networking/noproxy", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.NoProxy_get" ] }, "GET /api/appliance/networking/proxy": { "verb": "GET", "path": "/api/appliance/networking/proxy", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Proxy_list" ] }, "GET /api/appliance/networking/proxy/{protocol}": { "verb": "GET", "path": "/api/appliance/networking/proxy/{protocol}", "query_fields": [], "path_fields": [ { "name": "protocol", "type": "string", "optional": false, "description": "The protocol whose proxy configuration is requested.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Proxy_get" ] }, "GET /api/appliance/ntp": { "verb": "GET", "path": "/api/appliance/ntp", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Ntp_get" ] }, "GET /api/appliance/recovery": { "verb": "GET", "path": "/api/appliance/recovery", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery_get" ] }, "GET /api/appliance/recovery/backup/job": { "verb": "GET", "path": "/api/appliance/recovery/backup/job", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Job_list" ] }, "GET /api/appliance/recovery/backup/job/details": { "verb": "GET", "path": "/api/appliance/recovery/backup/job/details", "query_fields": [ { "name": "jobs", "type": "array", "optional": true, "description": "Identifiers of backup jobs that can match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Job.Details_list" ] }, "GET /api/appliance/recovery/backup/job/{id}": { "verb": "GET", "path": "/api/appliance/recovery/backup/job/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "ID (ID of job)", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Job_get" ] }, "GET /api/appliance/recovery/backup/parts": { "verb": "GET", "path": "/api/appliance/recovery/backup/parts", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Parts_list" ] }, "GET /api/appliance/recovery/backup/parts/{id}": { "verb": "GET", "path": "/api/appliance/recovery/backup/parts/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Identifier of the part.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Parts_get" ] }, "GET /api/appliance/recovery/backup/schedules": { "verb": "GET", "path": "/api/appliance/recovery/backup/schedules", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_list" ] }, "GET /api/appliance/recovery/backup/schedules/{schedule}": { "verb": "GET", "path": "/api/appliance/recovery/backup/schedules/{schedule}", "query_fields": [], "path_fields": [ { "name": "schedule", "type": "string", "optional": false, "description": "Identifier of the schedule", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_get" ] }, "GET /api/appliance/recovery/reconciliation/job": { "verb": "GET", "path": "/api/appliance/recovery/reconciliation/job", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Reconciliation.Job_get" ] }, "GET /api/appliance/recovery/restore/job": { "verb": "GET", "path": "/api/appliance/recovery/restore/job", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Restore.Job_get" ] }, "GET /api/appliance/services": { "verb": "GET", "path": "/api/appliance/services", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Services_list" ] }, "GET /api/appliance/services/{service}": { "verb": "GET", "path": "/api/appliance/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "identifier of the service whose state is being queried.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Services_get" ] }, "GET /api/appliance/shutdown": { "verb": "GET", "path": "/api/appliance/shutdown", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Shutdown_get" ] }, "GET /api/appliance/support-bundle": { "verb": "GET", "path": "/api/appliance/support-bundle", "query_fields": [ { "name": "iteration", "type": "object", "optional": true, "description": "This schema was added in __vSphere API 7.0.1.0__.", "enum": [], "example": { "size": 1 } }, { "name": "filter", "type": "object", "optional": true, "description": "This schema was added in __vSphere API 7.0.1.0__.", "enum": [], "example": { "available": false, "creation_status": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.SupportBundle_list" ] }, "GET /api/appliance/support-bundle/components": { "verb": "GET", "path": "/api/appliance/support-bundle/components", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.SupportBundle.Components_get" ] }, "GET /api/appliance/support-bundle/cores": { "verb": "GET", "path": "/api/appliance/support-bundle/cores", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Cores_list" ] }, "GET /api/appliance/system/crypto-hash": { "verb": "GET", "path": "/api/appliance/system/crypto-hash", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.CryptoHash_get" ] }, "GET /api/appliance/system/crypto-hash/options": { "verb": "GET", "path": "/api/appliance/system/crypto-hash/options", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.CryptoHash.Options_list" ] }, "GET /api/appliance/system/global-fips": { "verb": "GET", "path": "/api/appliance/system/global-fips", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Security.GlobalFips_get" ] }, "GET /api/appliance/system/storage": { "verb": "GET", "path": "/api/appliance/system/storage", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Storage_list" ] }, "GET /api/appliance/system/time": { "verb": "GET", "path": "/api/appliance/system/time", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Time_get" ] }, "GET /api/appliance/system/time/timezone": { "verb": "GET", "path": "/api/appliance/system/time/timezone", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Time.Timezone_get" ] }, "GET /api/appliance/system/uptime": { "verb": "GET", "path": "/api/appliance/system/uptime", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Uptime_get" ] }, "GET /api/appliance/system/version": { "verb": "GET", "path": "/api/appliance/system/version", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Version_get" ] }, "GET /api/appliance/timesync": { "verb": "GET", "path": "/api/appliance/timesync", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Timesync_get" ] }, "GET /api/appliance/tls/manual-parameters/global": { "verb": "GET", "path": "/api/appliance/tls/manual-parameters/global", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.ManualParameters.Global_get" ] }, "GET /api/appliance/tls/manual-parameters/services": { "verb": "GET", "path": "/api/appliance/tls/manual-parameters/services", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.ManualParameters.Services_list" ] }, "GET /api/appliance/tls/manual-parameters/services/{service}": { "verb": "GET", "path": "/api/appliance/tls/manual-parameters/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "for which the current TLS parameters has to be fetched.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.ManualParameters.Services_get" ] }, "GET /api/appliance/tls/profiles": { "verb": "GET", "path": "/api/appliance/tls/profiles", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.Profiles_list" ] }, "GET /api/appliance/tls/profiles/global": { "verb": "GET", "path": "/api/appliance/tls/profiles/global", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.Profiles.Global_get" ] }, "GET /api/appliance/tls/profiles/{profile}": { "verb": "GET", "path": "/api/appliance/tls/profiles/{profile}", "query_fields": [], "path_fields": [ { "name": "profile", "type": "string", "optional": false, "description": "Name of the TLS Profile for which the info is needed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Tls.Profiles_get" ] }, "GET /api/appliance/update": { "verb": "GET", "path": "/api/appliance/update", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update_get" ] }, "GET /api/appliance/update/pending": { "verb": "GET", "path": "/api/appliance/update/pending", "query_fields": [ { "name": "source_type", "type": "string", "optional": false, "description": "type of the source", "enum": [], "example": "example" }, { "name": "url", "type": "string", "optional": true, "description": "specific URL to check at", "enum": [], "example": "example" }, { "name": "enable_list_major_upgrade_versions", "type": "boolean", "optional": true, "description": "checks and lists if there are eligible major version upgrades available. Possible values are true and false", "enum": [], "example": false } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Pending_list" ] }, "GET /api/appliance/update/pending/{version}": { "verb": "GET", "path": "/api/appliance/update/pending/{version}", "query_fields": [ { "name": "component", "type": "string", "optional": true, "description": "Name of the upgradeable component", "enum": [], "example": "example" } ], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Update version", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Pending_get" ] }, "GET /api/appliance/update/pending/{version}/components": { "verb": "GET", "path": "/api/appliance/update/pending/{version}/components", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "specific version to check eligible updates", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Pending_listUpgradeableComponents" ] }, "GET /api/appliance/update/policy": { "verb": "GET", "path": "/api/appliance/update/policy", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Policy_get" ] }, "GET /api/appliance/update/staged": { "verb": "GET", "path": "/api/appliance/update/staged", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Staged_get" ] }, "GET /api/cis/tagging/category": { "verb": "GET", "path": "/api/cis/tagging/category", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Category_list" ] }, "GET /api/cis/tagging/category/{categoryId}": { "verb": "GET", "path": "/api/cis/tagging/category/{categoryId}", "query_fields": [], "path_fields": [ { "name": "categoryId", "type": "string", "optional": false, "description": "The identifier of the input category.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Category_get" ] }, "GET /api/cis/tagging/tag": { "verb": "GET", "path": "/api/cis/tagging/tag", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Tag_list" ] }, "GET /api/cis/tagging/tag/{tagId}": { "verb": "GET", "path": "/api/cis/tagging/tag/{tagId}", "query_fields": [], "path_fields": [ { "name": "tagId", "type": "string", "optional": false, "description": "The identifier of the input tag.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Tag_get" ] }, "GET /api/cis/tasks/{task}": { "verb": "GET", "path": "/api/cis/tasks/{task}", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Specification on what to get for a task.", "enum": [], "example": { "return_all": false, "exclude_result": false } } ], "path_fields": [ { "name": "task", "type": "string", "optional": false, "description": "Task identifier.", "enum": [], "example": "task-1" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tasks_get" ] }, "GET /api/content/configuration": { "verb": "GET", "path": "/api/content/configuration", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Configuration_get" ] }, "GET /api/content/library": { "verb": "GET", "path": "/api/content/library", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library_list" ] }, "GET /api/content/library/item": { "verb": "GET", "path": "/api/content/library/item", "query_fields": [ { "name": "library_id", "type": "string", "optional": false, "description": "Identifier of the library whose items should be returned.", "enum": [], "example": "library-demo" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item_list" ] }, "GET /api/content/library/item/download-session": { "verb": "GET", "path": "/api/content/library/item/download-session", "query_fields": [ { "name": "library_item_id", "type": "string", "optional": true, "description": "Library item identifier on which to filter results.", "enum": [], "example": "example" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.DownloadSession_list" ] }, "GET /api/content/library/item/download-session/{downloadSessionId}": { "verb": "GET", "path": "/api/content/library/item/download-session/{downloadSessionId}", "query_fields": [], "path_fields": [ { "name": "downloadSessionId", "type": "string", "optional": false, "description": "Identifier of the download session to retrieve.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.DownloadSession_get" ] }, "GET /api/content/library/item/download-session/{downloadSessionId}/file": { "verb": "GET", "path": "/api/content/library/item/download-session/{downloadSessionId}/file", "query_fields": [ { "name": "file_name", "type": "string", "optional": false, "description": "Name of the file requested.", "enum": [], "example": "example" } ], "path_fields": [ { "name": "downloadSessionId", "type": "string", "optional": false, "description": "Identifier of the download session.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Downloadsession.File_list", "Content.Library.Item.Downloadsession.File_get" ] }, "GET /api/content/library/item/update-session": { "verb": "GET", "path": "/api/content/library/item/update-session", "query_fields": [ { "name": "library_item_id", "type": "string", "optional": true, "description": "Optional library item identifier on which to filter results.", "enum": [], "example": "example" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.UpdateSession_list" ] }, "GET /api/content/library/item/update-session/{updateSessionId}": { "verb": "GET", "path": "/api/content/library/item/update-session/{updateSessionId}", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session to retrieve.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.UpdateSession_get" ] }, "GET /api/content/library/item/update-session/{updateSessionId}/file": { "verb": "GET", "path": "/api/content/library/item/update-session/{updateSessionId}/file", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Updatesession.File_list" ] }, "GET /api/content/library/item/update-session/{updateSessionId}/file/{fileName}": { "verb": "GET", "path": "/api/content/library/item/update-session/{updateSessionId}/file/{fileName}", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session.", "enum": [], "example": "example" }, { "name": "fileName", "type": "string", "optional": false, "description": "Name of the file.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Updatesession.File_get" ] }, "GET /api/content/library/item/{libraryItemId}": { "verb": "GET", "path": "/api/content/library/item/{libraryItemId}", "query_fields": [], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item to return.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item_get" ] }, "GET /api/content/library/item/{libraryItemId}/file": { "verb": "GET", "path": "/api/content/library/item/{libraryItemId}/file", "query_fields": [ { "name": "name", "type": "string", "optional": false, "description": "Name of the file in the library item whose information should be returned.", "enum": [], "example": "web-01" } ], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item whose files should be listed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.File_list", "Content.Library.Item.File_get" ] }, "GET /api/content/library/item/{libraryItemId}/storage": { "verb": "GET", "path": "/api/content/library/item/{libraryItemId}/storage", "query_fields": [ { "name": "file_name", "type": "string", "optional": false, "description": "Name of the file for which the storage information should be listed.", "enum": [], "example": "example" } ], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item whose storage information should be listed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Storage_list", "Content.Library.Item.Storage_get" ] }, "GET /api/content/library/item/{libraryItem}/changes": { "verb": "GET", "path": "/api/content/library/item/{libraryItem}/changes", "query_fields": [], "path_fields": [ { "name": "libraryItem", "type": "string", "optional": false, "description": "Library item identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Changes_list" ] }, "GET /api/content/library/item/{libraryItem}/changes/{version}": { "verb": "GET", "path": "/api/content/library/item/{libraryItem}/changes/{version}", "query_fields": [], "path_fields": [ { "name": "libraryItem", "type": "string", "optional": false, "description": "Library item identifer.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Library item version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Changes_get" ] }, "GET /api/content/library/{libraryId}": { "verb": "GET", "path": "/api/content/library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the library to return.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library_get" ] }, "GET /api/content/library/{library}/subscriptions": { "verb": "GET", "path": "/api/content/library/{library}/subscriptions", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier of the published library.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Subscriptions_list" ] }, "GET /api/content/library/{library}/subscriptions/{subscription}": { "verb": "GET", "path": "/api/content/library/{library}/subscriptions/{subscription}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier of the published library.", "enum": [], "example": "example" }, { "name": "subscription", "type": "string", "optional": false, "description": "Identifier of the subscription.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Subscriptions_get" ] }, "GET /api/content/library/{library}/usages": { "verb": "GET", "path": "/api/content/library/{library}/usages", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "The identifier of the content library for which the usage needs to be listed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Usages_list" ] }, "GET /api/content/library/{library}/usages/{usage}": { "verb": "GET", "path": "/api/content/library/{library}/usages/{usage}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "The identifier of the content library.", "enum": [], "example": "example" }, { "name": "usage", "type": "string", "optional": false, "description": "The identifier of the content library usage.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Usages_get" ] }, "GET /api/content/local-library": { "verb": "GET", "path": "/api/content/local-library", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.LocalLibrary_list" ] }, "GET /api/content/local-library/{libraryId}": { "verb": "GET", "path": "/api/content/local-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the local library to return.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.LocalLibrary_get" ] }, "GET /api/content/security-policies": { "verb": "GET", "path": "/api/content/security-policies", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.SecurityPolicies_list" ] }, "GET /api/content/subscribed-library": { "verb": "GET", "path": "/api/content/subscribed-library", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.SubscribedLibrary_list" ] }, "GET /api/content/subscribed-library/{libraryId}": { "verb": "GET", "path": "/api/content/subscribed-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the subscribed library to return.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.SubscribedLibrary_get" ] }, "GET /api/content/trusted-certificates": { "verb": "GET", "path": "/api/content/trusted-certificates", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.TrustedCertificates_list" ] }, "GET /api/content/trusted-certificates/{certificate}": { "verb": "GET", "path": "/api/content/trusted-certificates/{certificate}", "query_fields": [], "path_fields": [ { "name": "certificate", "type": "string", "optional": false, "description": "id of the trusted certificate.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.TrustedCertificates_get" ] }, "GET /api/content/type": { "verb": "GET", "path": "/api/content/type", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Type_list" ] }, "GET /api/esx/hcl/compatibility-data/status": { "verb": "GET", "path": "/api/esx/hcl/compatibility-data/status", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hcl.CompatibilityData_get" ] }, "GET /api/esx/hcl/hosts/{host}/compatibility-releases": { "verb": "GET", "path": "/api/esx/hcl/hosts/{host}/compatibility-releases", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Contains the MoID identifying the ESXi host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hcl.Hosts.CompatibilityReleases_list" ] }, "GET /api/esx/hcl/hosts/{host}/compatibility-report": { "verb": "GET", "path": "/api/esx/hcl/hosts/{host}/compatibility-report", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The parameter must be an identifier for the resource type: `HostSystem`.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hcl.Hosts.CompatibilityReport_get" ] }, "GET /api/esx/hcl/reports/{report}": { "verb": "GET", "path": "/api/esx/hcl/reports/{report}", "query_fields": [], "path_fields": [ { "name": "report", "type": "string", "optional": false, "description": "identifier of hardware compatibility report to be downloaded.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hcl.Reports_get" ] }, "GET /api/esx/hosts/{host}/software/installed-components": { "verb": "GET", "path": "/api/esx/hosts/{host}/software/installed-components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hosts.Software.InstalledComponents_list" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration", "query_fields": [ { "name": "commit", "type": "string", "optional": true, "description": "Identifier of the commit to get.", "enum": [], "example": "example" }, { "name": "doc_structure", "type": "string", "optional": true, "description": "Possible values:", "enum": [], "example": "example" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration_get" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/audit-records": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/audit-records", "query_fields": [ { "name": "filters", "type": "object", "optional": true, "description": "used to filter the audit records.", "enum": [], "example": { "time_duration": "example" } }, { "name": "operations", "type": "array", "optional": true, "description": "List of audit records that match the given operations An operation in operations can be any of", "enum": [], "example": [ "example" ] }, { "name": "usernames", "type": "array", "optional": true, "description": "List of audit records that match the given users", "enum": [], "example": [ "example" ] }, { "name": "start", "type": "string", "optional": true, "description": "List of audit records that match the given start time i.e. occurred after the DateTime start.", "enum": [], "example": "example" }, { "name": "end", "type": "string", "optional": true, "description": "List of audit records that match the given end time i.e. occurred before the DateTime end.", "enum": [], "example": "example" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.AuditRecords_list" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/drafts": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/drafts", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Drafts_list" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "getSchema", "showChanges" ], "example": "getSchema" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Drafts_get", "Esx.Settings.Clusters.Configuration.Drafts_getSchema", "Esx.Settings.Clusters.Configuration.Drafts_showChanges" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/reports/last-apply-result": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/reports/last-apply-result", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Reports.LastApplyResult_get" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/reports/last-compliance-result": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/reports/last-compliance-result", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Reports.LastComplianceResult_get" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/reports/last-precheck-result": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/reports/last-precheck-result", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Reports.LastPrecheckResult_get" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/reports/recent-tasks": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/reports/recent-tasks", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Reports.RecentTasks_get" ] }, "GET /api/esx/settings/clusters/{cluster}/configuration/schema": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/configuration/schema", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Schema_get" ] }, "GET /api/esx/settings/clusters/{cluster}/depot-overrides": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/depot-overrides", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.DepotOverrides_get" ] }, "GET /api/esx/settings/clusters/{cluster}/enablement/configuration": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/enablement/configuration", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Configuration_get" ] }, "GET /api/esx/settings/clusters/{cluster}/enablement/configuration/transition": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/enablement/configuration/transition", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Configuration.Transition_get" ] }, "GET /api/esx/settings/clusters/{cluster}/enablement/software": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/enablement/software", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Software_get" ] }, "GET /api/esx/settings/clusters/{cluster}/installed-images": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/installed-images", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.InstalledImages_get" ] }, "GET /api/esx/settings/clusters/{cluster}/policies/apply": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/policies/apply", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Policies.Apply_get" ] }, "GET /api/esx/settings/clusters/{cluster}/policies/apply/effective": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/policies/apply/effective", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Policies.Apply.Effective_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software_get", "Esx.Settings.Clusters.Software_getDefaultImage" ] }, "GET /api/esx/settings/clusters/{cluster}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AddOn_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/display-name": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.DisplayName_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/selection-criteria": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/selection-criteria", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.SelectionCriteria_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.AddOn_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/base-image", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.BaseImage_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.Components_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.Components_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.EffectiveComponents_list", "Esx.Settings.Clusters.Software.AlternativeImages.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/hardware-support": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.HardwareSupport_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/solutions": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/solutions", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.Solutions_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/solutions/{solution}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software.Solutions_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/base-image", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.BaseImage_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/commits/{commit}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/commits/{commit}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "commit", "type": "string", "optional": false, "description": "Identifier of the specific commit.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Commits_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/compliance": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/compliance", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Compliance_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Components_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Components_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/display-name": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software_getDisplayName" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts", "query_fields": [ { "name": "owners", "type": "array", "optional": true, "description": "Owners of the drafts.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/display-name": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.DisplayName_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AddOn_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/display-name": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.DisplayName_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/selection-criteria": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/selection-criteria", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.SelectionCriteria_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.AddOn_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/base-image", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.BaseImage_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.Components_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.Components_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.EffectiveComponents_list", "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.HardwareSupport_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.BaseImage_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.Components_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.Components_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.EffectiveComponents_list", "Esx.Settings.Clusters.Software.Drafts.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.HardwareSupport_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.EffectiveComponents_list", "Esx.Settings.Clusters.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/clusters/{cluster}/software/hardware-support": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.HardwareSupport_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/recommendations": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/recommendations", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Recommendations_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/reports/apply-impact": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/reports/apply-impact", "query_fields": [ { "name": "hosts", "type": "array", "optional": true, "description": "The specific hosts for which an impact is to be generated.", "enum": [], "example": [ "host-11" ] } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.ApplyImpact_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/details", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.Details_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/reports/last-apply-result": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/reports/last-apply-result", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.LastApplyResult_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/reports/last-check-result": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/reports/last-check-result", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.LastCheckResult_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/software-spec-metadata": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/software-spec-metadata", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.SoftwareSpecMetadata_get" ] }, "GET /api/esx/settings/clusters/{cluster}/software/solutions": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/solutions", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Solutions_list" ] }, "GET /api/esx/settings/clusters/{cluster}/software/solutions/{solution}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Solutions_get" ] }, "GET /api/esx/settings/clusters/{cluster}/vms/lifecycle-hooks/{solution}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/vms/lifecycle-hooks/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.LifecycleHooks_list" ] }, "GET /api/esx/settings/clusters/{cluster}/vms/solutions": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/vms/solutions", "query_fields": [ { "name": "solutions", "type": "array", "optional": true, "description": "Solutions to return desired specification for.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.Solutions_list" ] }, "GET /api/esx/settings/clusters/{cluster}/vms/solutions/{solution}": { "verb": "GET", "path": "/api/esx/settings/clusters/{cluster}/vms/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.Solutions_get" ] }, "GET /api/esx/settings/defaults/clusters/policies/apply": { "verb": "GET", "path": "/api/esx/settings/defaults/clusters/policies/apply", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Defaults.Clusters.Policies.Apply_get" ] }, "GET /api/esx/settings/defaults/clusters/policies/apply/effective": { "verb": "GET", "path": "/api/esx/settings/defaults/clusters/policies/apply/effective", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Defaults.Clusters.Policies.Apply.Effective_get" ] }, "GET /api/esx/settings/defaults/hosts/policies/apply": { "verb": "GET", "path": "/api/esx/settings/defaults/hosts/policies/apply", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Defaults.Hosts.Policies.Apply_get" ] }, "GET /api/esx/settings/defaults/hosts/policies/apply/effective": { "verb": "GET", "path": "/api/esx/settings/defaults/hosts/policies/apply/effective", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Defaults.Hosts.Policies.Apply.Effective_get" ] }, "GET /api/esx/settings/depot-content/add-ons": { "verb": "GET", "path": "/api/esx/settings/depot-content/add-ons", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "The specification of matching OEM add-ons.", "enum": [], "example": { "min_version": "example" } }, { "name": "vendors", "type": "array", "optional": true, "description": "Vendors that an add-on must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that an add-on must have to match the filter.", "enum": [], "example": [ "web-01" ] }, { "name": "versions", "type": "array", "optional": true, "description": "Versions that an add-on must have to match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.AddOns_list" ] }, "GET /api/esx/settings/depot-content/add-ons/{name}/versions/{version}": { "verb": "GET", "path": "/api/esx/settings/depot-content/add-ons/{name}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "Name of the OEM add-on", "enum": [], "example": "web-01" }, { "name": "version", "type": "string", "optional": false, "description": "Version of the OEM add-on", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.AddOns.Versions_get" ] }, "GET /api/esx/settings/depot-content/base-images": { "verb": "GET", "path": "/api/esx/settings/depot-content/base-images", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "The specification of matching base images.", "enum": [], "example": { "min_version": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.BaseImages_list" ] }, "GET /api/esx/settings/depot-content/base-images/versions/{version}": { "verb": "GET", "path": "/api/esx/settings/depot-content/base-images/versions/{version}", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Version of the base image", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.BaseImages.Versions_get" ] }, "GET /api/esx/settings/depot-content/components": { "verb": "GET", "path": "/api/esx/settings/depot-content/components", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "The specification of matching components.", "enum": [], "example": { "min_version": "example" } }, { "name": "vendors", "type": "array", "optional": true, "description": "Vendors that a component must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that a component must have to match the filter.", "enum": [], "example": [ "web-01" ] }, { "name": "versions", "type": "array", "optional": true, "description": "Versions that a component must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "bundle_types", "type": "array", "optional": true, "description": "Component bundle types that a component must have to match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.Components_list" ] }, "GET /api/esx/settings/depot-content/components/{name}/versions/{version}": { "verb": "GET", "path": "/api/esx/settings/depot-content/components/{name}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "Name of the component", "enum": [], "example": "web-01" }, { "name": "version", "type": "string", "optional": false, "description": "Version of the component", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.DepotContent.Components.Versions_get" ] }, "GET /api/esx/settings/depots/offline": { "verb": "GET", "path": "/api/esx/settings/depots/offline", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Offline_list" ] }, "GET /api/esx/settings/depots/offline/{depot}": { "verb": "GET", "path": "/api/esx/settings/depots/offline/{depot}", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier for the depot.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Offline_get" ] }, "GET /api/esx/settings/depots/offline/{depot}/content": { "verb": "GET", "path": "/api/esx/settings/depots/offline/{depot}/content", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier for the depot.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Offline.Content_get" ] }, "GET /api/esx/settings/depots/online": { "verb": "GET", "path": "/api/esx/settings/depots/online", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Online_list" ] }, "GET /api/esx/settings/depots/online/{depot}": { "verb": "GET", "path": "/api/esx/settings/depots/online/{depot}", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier for the depot.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Online_get" ] }, "GET /api/esx/settings/depots/online/{depot}/content": { "verb": "GET", "path": "/api/esx/settings/depots/online/{depot}/content", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier for the depot.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Online.Content_get" ] }, "GET /api/esx/settings/depots/sync-schedule": { "verb": "GET", "path": "/api/esx/settings/depots/sync-schedule", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.SyncSchedule_get" ] }, "GET /api/esx/settings/depots/umds": { "verb": "GET", "path": "/api/esx/settings/depots/umds", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Umds_get" ] }, "GET /api/esx/settings/depots/umds/content": { "verb": "GET", "path": "/api/esx/settings/depots/umds/content", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Umds.Content_get" ] }, "GET /api/esx/settings/hardware-support/managers": { "verb": "GET", "path": "/api/esx/settings/hardware-support/managers", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.HardwareSupport.Managers_list" ] }, "GET /api/esx/settings/hardware-support/managers/{manager}/packages": { "verb": "GET", "path": "/api/esx/settings/hardware-support/managers/{manager}/packages", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of Hardware Support Packages (HSPs) to be returned", "enum": [], "example": { "base_image_version": "example" } } ], "path_fields": [ { "name": "manager", "type": "string", "optional": false, "description": "Identifier for the Hardware Support Manager (HSM).", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.HardwareSupport.Managers.Packages_list" ] }, "GET /api/esx/settings/hardware-support/managers/{manager}/packages/{pkg}/versions/{version}": { "verb": "GET", "path": "/api/esx/settings/hardware-support/managers/{manager}/packages/{pkg}/versions/{version}", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of detailed information to be returned", "enum": [], "example": { "base_image_version": "example" } } ], "path_fields": [ { "name": "manager", "type": "string", "optional": false, "description": "Identifier for the Hardware Support Manager (HSM).", "enum": [], "example": "example" }, { "name": "pkg", "type": "string", "optional": false, "description": "The name of the Hardware Support Package (HSP)", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "The version of the Hardware Support Package (HSP)", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.HardwareSupport.Managers.Packages.Versions_get" ] }, "GET /api/esx/settings/hosts/{host}/depot-overrides": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/depot-overrides", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier for the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.DepotOverrides_get" ] }, "GET /api/esx/settings/hosts/{host}/enablement/software": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/enablement/software", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Enablement.Software_get" ] }, "GET /api/esx/settings/hosts/{host}/policies/apply": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/policies/apply", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Policies.Apply_get" ] }, "GET /api/esx/settings/hosts/{host}/policies/apply/effective": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/policies/apply/effective", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Policies.Apply.Effective_get" ] }, "GET /api/esx/settings/hosts/{host}/software": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software_get" ] }, "GET /api/esx/settings/hosts/{host}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/add-on", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.AddOn_get" ] }, "GET /api/esx/settings/hosts/{host}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/base-image", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.BaseImage_get" ] }, "GET /api/esx/settings/hosts/{host}/software/commits/{commit}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/commits/{commit}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "commit", "type": "string", "optional": false, "description": "Identifier of the specific commit.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Commits_get" ] }, "GET /api/esx/settings/hosts/{host}/software/compliance": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/compliance", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Compliance_get" ] }, "GET /api/esx/settings/hosts/{host}/software/components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Components_list" ] }, "GET /api/esx/settings/hosts/{host}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Components_get" ] }, "GET /api/esx/settings/hosts/{host}/software/display-name": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/display-name", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software_getDisplayName" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts", "query_fields": [ { "name": "owners", "type": "array", "optional": true, "description": "Owners of the drafts.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts_list" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts_get" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/display-name": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.DisplayName_get" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.AddOn_get" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.BaseImage_get" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.Components_list" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.Components_get" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.EffectiveComponents_list", "Esx.Settings.Hosts.Software.Drafts.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the standalone host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the standalone host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/hosts/{host}/software/effective-components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/effective-components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.EffectiveComponents_list", "Esx.Settings.Hosts.Software.EffectiveComponents_listWithRemovedComponents" ] }, "GET /api/esx/settings/hosts/{host}/software/recommendations": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/recommendations", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Recommendations_get" ] }, "GET /api/esx/settings/hosts/{host}/software/removed-components": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/removed-components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.RemovedComponents_list" ] }, "GET /api/esx/settings/hosts/{host}/software/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.RemovedComponents_get" ] }, "GET /api/esx/settings/hosts/{host}/software/reports/apply-impact": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/reports/apply-impact", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Reports.ApplyImpact_get" ] }, "GET /api/esx/settings/hosts/{host}/software/reports/last-apply-result": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/reports/last-apply-result", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "the host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Reports.LastApplyResult_get" ] }, "GET /api/esx/settings/hosts/{host}/software/reports/last-check-result": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/reports/last-check-result", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Reports.LastCheckResult_get" ] }, "GET /api/esx/settings/hosts/{host}/software/software-spec-metadata": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/software-spec-metadata", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.SoftwareSpecMetadata_get" ] }, "GET /api/esx/settings/hosts/{host}/software/solutions": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/solutions", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Solutions_list" ] }, "GET /api/esx/settings/hosts/{host}/software/solutions/{solution}": { "verb": "GET", "path": "/api/esx/settings/hosts/{host}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Solutions_get" ] }, "GET /api/esx/settings/inventory/reports/summary/clusters": { "verb": "GET", "path": "/api/esx/settings/inventory/reports/summary/clusters", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Describe the inventory objects on which the specified operation will be performed.", "enum": [], "example": { "type": "example" } }, { "name": "clusters", "type": "array", "optional": true, "description": "List of clusters on which the operations summary needs to be generated.", "enum": [], "example": [ "domain-c21" ] }, { "name": "folders", "type": "array", "optional": true, "description": "List of folders on which the operations summary needs to be generated. Internally the folder entities will be expanded to individual clusters which are under...", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "List of data-centers on which the operations summary needs to be generated. Internally the data-center entities will be expanded to individual clusters which...", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Inventory.Reports.Summary.Clusters_get" ] }, "GET /api/esx/settings/inventory/reports/summary/hosts": { "verb": "GET", "path": "/api/esx/settings/inventory/reports/summary/hosts", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Describe the inventory objects on which the specified operation will be performed.", "enum": [], "example": { "type": "example" } }, { "name": "hosts", "type": "array", "optional": true, "description": "List of standalone hosts on which the operations summary needs to be generated.", "enum": [], "example": [ "host-11" ] }, { "name": "folders", "type": "array", "optional": true, "description": "List of folders on which the operations summary needs to be generated. Internally the folder entities will be expanded to individual standalone hosts which a...", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "List of data-centers on which the operations summary needs to be generated. Internally the data-center entities will be expanded to individual standalone hos...", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Inventory.Reports.Summary.Hosts_get" ] }, "GET /api/esx/settings/inventory/reports/transition-summary/clusters": { "verb": "GET", "path": "/api/esx/settings/inventory/reports/transition-summary/clusters", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Describe the inventory objects on which the specified operation will be performed.", "enum": [], "example": { "type": "example" } }, { "name": "clusters", "type": "array", "optional": true, "description": "List of clusters on which the specified operation needs to be executed.", "enum": [], "example": [ "domain-c21" ] }, { "name": "folders", "type": "array", "optional": true, "description": "List of folders on which the specified operation will be executed. Internally each folder entity will be expanded to individual baseline managed clusters whi...", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "List of the data-centers on which the specified operation will be executed. Internally each data-center entity will be expanded to individual baseline manage...", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Inventory.Reports.TransitionSummary.Clusters_get" ] }, "GET /api/esx/settings/inventory/reports/transition-summary/hosts": { "verb": "GET", "path": "/api/esx/settings/inventory/reports/transition-summary/hosts", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Describe the inventory objects on which the specified operation will be performed.", "enum": [], "example": { "type": "example" } }, { "name": "hosts", "type": "array", "optional": true, "description": "List of standalone hosts on which the specified operation needs to be executed.", "enum": [], "example": [ "host-11" ] }, { "name": "folders", "type": "array", "optional": true, "description": "List of folders on which the specified operation will be executed. Internally each folder entity will be expanded to individual baseline managed standalone h...", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "List of the data-centers on which the specified operation will be executed. Internally each data-center entity will be expanded to individual baseline manage...", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Inventory.Reports.TransitionSummary.Hosts_get" ] }, "GET /api/esx/settings/repository/software": { "verb": "GET", "path": "/api/esx/settings/repository/software", "query_fields": [ { "name": "owners", "type": "array", "optional": true, "description": "Filter software specification in repository based on the image owners.", "enum": [], "example": [ "example" ] }, { "name": "display_names", "type": "array", "optional": true, "description": "Filter software specification in repository based on the display names.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software_list" ] }, "GET /api/esx/settings/repository/software/drafts": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts", "query_fields": [ { "name": "software_spec_ids", "type": "array", "optional": true, "description": "Software specification identifier for which the draft is created. If the software specification identifier is set to -1, global software drafts are returned.", "enum": [], "example": [ "example" ] }, { "name": "owners", "type": "array", "optional": true, "description": "Owners of the drafts.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/add-on": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AddOn_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.AddOn_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/base-image": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/base-image", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.BaseImage_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.Components_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.Components_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/display-name": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/display-name", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.DisplayName_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/effective-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/effective-components", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Filter spec to indicate whether removed components are included.", "enum": [], "example": { "with_removed_components": false } } ], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.EffectiveComponents_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.HardwareSupport_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.RemovedComponents_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.RemovedComponents_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/selection-criteria": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/selection-criteria", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.SelectionCriteria_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/base-image": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/base-image", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.BaseImage_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.Components_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/components/{component}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.Components_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/display-name": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software specification draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.DisplayName_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/effective-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/effective-components", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Filter spec to indicate whether removed components are included.", "enum": [], "example": { "with_removed_components": false } } ], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.EffectiveComponents_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/hardware-support": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.HardwareSupport_get" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/removed-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/removed-components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.RemovedComponents_list" ] }, "GET /api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}": { "verb": "GET", "path": "/api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.RemovedComponents_get" ] }, "GET /api/esx/settings/repository/software/{softwareSpec}": { "verb": "GET", "path": "/api/esx/settings/repository/software/{softwareSpec}", "query_fields": [], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "The identifier of the software specification in the repository.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software_get" ] }, "GET /api/esx/settings/repository/software/{softwareSpec}/alternative-images/{image}/effective-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/{softwareSpec}/alternative-images/{image}/effective-components", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Filter spec to indicate whether removed components are included.", "enum": [], "example": { "with_removed_components": false } } ], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "The identifier of the software specification in the repository.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.AlternativeImages.EffectiveComponents_list" ] }, "GET /api/esx/settings/repository/software/{softwareSpec}/effective-components": { "verb": "GET", "path": "/api/esx/settings/repository/software/{softwareSpec}/effective-components", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Filter spec to indicate whether removed components are included.", "enum": [], "example": { "with_removed_components": false } } ], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "The identifier of the software specification in the repository.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.EffectiveComponents_list" ] }, "GET /api/esx/software": { "verb": "GET", "path": "/api/esx/software", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "auth_type", "type": "string", "description": "auth_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "auth_type": "example" }, "operation_ids": [ "Esx.Hosts.Software_get" ] }, "GET /api/session": { "verb": "GET", "path": "/api/session", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Session_get" ] }, "GET /api/stats/acq-specs": { "verb": "GET", "path": "/api/stats/acq-specs", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Criteria for selecting records to return.", "enum": [], "example": { "page": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.AcqSpecs_list" ] }, "GET /api/stats/acq-specs/{id}": { "verb": "GET", "path": "/api/stats/acq-specs/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Acquisition specification ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.AcqSpecs_get" ] }, "GET /api/stats/counter-sets": { "verb": "GET", "path": "/api/stats/counter-sets", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.CounterSets_list" ] }, "GET /api/stats/counter-sets/{counterSet}": { "verb": "GET", "path": "/api/stats/counter-sets/{counterSet}", "query_fields": [], "path_fields": [ { "name": "counterSet", "type": "string", "optional": false, "description": "identifier of the counter set to retrieve.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.CounterSets_get" ] }, "GET /api/stats/counters": { "verb": "GET", "path": "/api/stats/counters", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Filters the returned records.", "enum": [], "example": { "cid": "example", "metric": "example" } }, { "name": "types", "type": "array", "optional": true, "description": "Resource type filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.Counters_list" ] }, "GET /api/stats/counters/{cid}": { "verb": "GET", "path": "/api/stats/counters/{cid}", "query_fields": [], "path_fields": [ { "name": "cid", "type": "string", "optional": false, "description": "Counter ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.Counters_get" ] }, "GET /api/stats/counters/{cid}/metadata": { "verb": "GET", "path": "/api/stats/counters/{cid}/metadata", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Filter specification.", "enum": [], "example": { "status": "example" } } ], "path_fields": [ { "name": "cid", "type": "string", "optional": false, "description": "Counter ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.CounterMetadata_list" ] }, "GET /api/stats/counters/{cid}/metadata/default": { "verb": "GET", "path": "/api/stats/counters/{cid}/metadata/default", "query_fields": [], "path_fields": [ { "name": "cid", "type": "string", "optional": false, "description": "Counter ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.CounterMetadata_getDefault" ] }, "GET /api/stats/counters/{cid}/metadata/{mid}": { "verb": "GET", "path": "/api/stats/counters/{cid}/metadata/{mid}", "query_fields": [], "path_fields": [ { "name": "cid", "type": "string", "optional": false, "description": "Counter ID.", "enum": [], "example": "example" }, { "name": "mid", "type": "string", "optional": false, "description": "CounterMetadata ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.CounterMetadata_get" ] }, "GET /api/stats/data/dp": { "verb": "GET", "path": "/api/stats/data/dp", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification to match DataPoints.", "enum": [], "example": { "start": 1, "end": 1, "cid": "example", "metric": "example", "order": "example", "page": "example" } }, { "name": "types", "type": "array", "optional": true, "description": "List of Resource types.", "enum": [], "example": [ "example" ] }, { "name": "rsrcs", "type": "array", "optional": true, "description": "Resources to include in the query. Each resource is specified through a composite string that follows the following format.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.Data_queryDataPoints" ] }, "GET /api/stats/metrics": { "verb": "GET", "path": "/api/stats/metrics", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.Metrics_list" ] }, "GET /api/stats/providers": { "verb": "GET", "path": "/api/stats/providers", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.Providers_list" ] }, "GET /api/stats/rsrc-addr-schemas/{id}": { "verb": "GET", "path": "/api/stats/rsrc-addr-schemas/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Resource address schema identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.ResourceAddressSchemas_get" ] }, "GET /api/stats/rsrc-addrs": { "verb": "GET", "path": "/api/stats/rsrc-addrs", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Criteria for selecting records to return.", "enum": [], "example": { "page": "example" } }, { "name": "types", "type": "array", "optional": true, "description": "List of Resource types.", "enum": [], "example": [ "example" ] }, { "name": "rsrcs", "type": "array", "optional": true, "description": "Resources to include in the query. Each resource is specified through a composite string that follows the following format.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.ResourceAddresses_list" ] }, "GET /api/stats/rsrc-addrs/{id}": { "verb": "GET", "path": "/api/stats/rsrc-addrs/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Resource Address ID.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.ResourceAddresses_get" ] }, "GET /api/stats/rsrc-types": { "verb": "GET", "path": "/api/stats/rsrc-types", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vstats.ResourceTypes_list" ] }, "GET /api/vapi/metadata/authentication/component": { "verb": "GET", "path": "/api/vapi/metadata/authentication/component", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Component_list" ] }, "GET /api/vapi/metadata/authentication/component/{componentId}": { "verb": "GET", "path": "/api/vapi/metadata/authentication/component/{componentId}", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Component_get" ] }, "GET /api/vapi/metadata/authentication/component/{componentId}/fingerprint": { "verb": "GET", "path": "/api/vapi/metadata/authentication/component/{componentId}/fingerprint", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Component_fingerprint" ] }, "GET /api/vapi/metadata/authentication/package": { "verb": "GET", "path": "/api/vapi/metadata/authentication/package", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Package_list" ] }, "GET /api/vapi/metadata/authentication/package/{packageId}": { "verb": "GET", "path": "/api/vapi/metadata/authentication/package/{packageId}", "query_fields": [], "path_fields": [ { "name": "packageId", "type": "string", "optional": false, "description": "Identifier of the package element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Package_get" ] }, "GET /api/vapi/metadata/authentication/service": { "verb": "GET", "path": "/api/vapi/metadata/authentication/service", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Service_list" ] }, "GET /api/vapi/metadata/authentication/service/{serviceId}": { "verb": "GET", "path": "/api/vapi/metadata/authentication/service/{serviceId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Service_get" ] }, "GET /api/vapi/metadata/authentication/service/{serviceId}/operation": { "verb": "GET", "path": "/api/vapi/metadata/authentication/service/{serviceId}/operation", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Service.Operation_list" ] }, "GET /api/vapi/metadata/authentication/service/{serviceId}/operation/{operationId}": { "verb": "GET", "path": "/api/vapi/metadata/authentication/service/{serviceId}/operation/{operationId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" }, { "name": "operationId", "type": "string", "optional": false, "description": "Identifier of the operation element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Authentication.Service.Operation_get" ] }, "GET /api/vapi/metadata/cli/command": { "verb": "GET", "path": "/api/vapi/metadata/cli/command", "query_fields": [ { "name": "path", "type": "string", "optional": true, "description": "The dot-separated path of the namespace for which command identifiers should be returned.", "enum": [], "example": "example" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Command_list" ] }, "GET /api/vapi/metadata/cli/command/fingerprint": { "verb": "GET", "path": "/api/vapi/metadata/cli/command/fingerprint", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Command_fingerprint" ] }, "GET /api/vapi/metadata/cli/namespace": { "verb": "GET", "path": "/api/vapi/metadata/cli/namespace", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Namespace_list" ] }, "GET /api/vapi/metadata/cli/namespace/fingerprint": { "verb": "GET", "path": "/api/vapi/metadata/cli/namespace/fingerprint", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Namespace_fingerprint" ] }, "GET /api/vapi/metadata/metamodel/component": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/component", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Component_list" ] }, "GET /api/vapi/metadata/metamodel/component/{componentId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/component/{componentId}", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Component_get" ] }, "GET /api/vapi/metadata/metamodel/component/{componentId}/fingerprint": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/component/{componentId}/fingerprint", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Component_fingerprint" ] }, "GET /api/vapi/metadata/metamodel/enumeration": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/enumeration", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Enumeration_list" ] }, "GET /api/vapi/metadata/metamodel/enumeration/{enumerationId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/enumeration/{enumerationId}", "query_fields": [], "path_fields": [ { "name": "enumerationId", "type": "string", "optional": false, "description": "Identifier of the enumeration element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Enumeration_get" ] }, "GET /api/vapi/metadata/metamodel/package": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/package", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Package_list" ] }, "GET /api/vapi/metadata/metamodel/package/{packageId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/package/{packageId}", "query_fields": [], "path_fields": [ { "name": "packageId", "type": "string", "optional": false, "description": "Identifier of the package element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Package_get" ] }, "GET /api/vapi/metadata/metamodel/resource": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/resource", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Resource_list" ] }, "GET /api/vapi/metadata/metamodel/resource/{resourceId}/model": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/resource/{resourceId}/model", "query_fields": [], "path_fields": [ { "name": "resourceId", "type": "string", "optional": false, "description": "Identifier of the resource type.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Resource.Model_list" ] }, "GET /api/vapi/metadata/metamodel/service": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/service", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Service_list" ] }, "GET /api/vapi/metadata/metamodel/service/{serviceId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/service/{serviceId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Service_get" ] }, "GET /api/vapi/metadata/metamodel/service/{serviceId}/operation": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/service/{serviceId}/operation", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Service.Operation_list" ] }, "GET /api/vapi/metadata/metamodel/service/{serviceId}/operation/{operationId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/service/{serviceId}/operation/{operationId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" }, { "name": "operationId", "type": "string", "optional": false, "description": "Identifier of the operation element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Service.Operation_get" ] }, "GET /api/vapi/metadata/metamodel/structure": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/structure", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Structure_list" ] }, "GET /api/vapi/metadata/metamodel/structure/{structureId}": { "verb": "GET", "path": "/api/vapi/metadata/metamodel/structure/{structureId}", "query_fields": [], "path_fields": [ { "name": "structureId", "type": "string", "optional": false, "description": "Identifier of the structure element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Metamodel.Structure_get" ] }, "GET /api/vapi/metadata/privilege/component": { "verb": "GET", "path": "/api/vapi/metadata/privilege/component", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Component_list" ] }, "GET /api/vapi/metadata/privilege/component/{componentId}": { "verb": "GET", "path": "/api/vapi/metadata/privilege/component/{componentId}", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Component_get" ] }, "GET /api/vapi/metadata/privilege/component/{componentId}/fingerprint": { "verb": "GET", "path": "/api/vapi/metadata/privilege/component/{componentId}/fingerprint", "query_fields": [], "path_fields": [ { "name": "componentId", "type": "string", "optional": false, "description": "Identifier of the component element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Component_fingerprint" ] }, "GET /api/vapi/metadata/privilege/package": { "verb": "GET", "path": "/api/vapi/metadata/privilege/package", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Package_list" ] }, "GET /api/vapi/metadata/privilege/package/{packageId}": { "verb": "GET", "path": "/api/vapi/metadata/privilege/package/{packageId}", "query_fields": [], "path_fields": [ { "name": "packageId", "type": "string", "optional": false, "description": "Identifier of the package element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Package_get" ] }, "GET /api/vapi/metadata/privilege/service": { "verb": "GET", "path": "/api/vapi/metadata/privilege/service", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Service_list" ] }, "GET /api/vapi/metadata/privilege/service/{serviceId}": { "verb": "GET", "path": "/api/vapi/metadata/privilege/service/{serviceId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Service_get" ] }, "GET /api/vapi/metadata/privilege/service/{serviceId}/operation": { "verb": "GET", "path": "/api/vapi/metadata/privilege/service/{serviceId}/operation", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Service.Operation_list" ] }, "GET /api/vapi/metadata/privilege/service/{serviceId}/operation/{operationId}": { "verb": "GET", "path": "/api/vapi/metadata/privilege/service/{serviceId}/operation/{operationId}", "query_fields": [], "path_fields": [ { "name": "serviceId", "type": "string", "optional": false, "description": "Identifier of the service element.", "enum": [], "example": "example" }, { "name": "operationId", "type": "string", "optional": false, "description": "Identifier of the operation element.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Privilege.Service.Operation_get" ] }, "GET /api/vcenter/authorization/permissions/{permission}": { "verb": "GET", "path": "/api/vcenter/authorization/permissions/{permission}", "query_fields": [], "path_fields": [ { "name": "permission", "type": "string", "optional": false, "description": "the unique identifier of the permission.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Permissions_get" ] }, "GET /api/vcenter/authorization/privilege-checks/latest": { "verb": "GET", "path": "/api/vcenter/authorization/privilege-checks/latest", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.PrivilegeChecks.Latest_get" ] }, "GET /api/vcenter/authorization/privileges": { "verb": "GET", "path": "/api/vcenter/authorization/privileges", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Return only privileges matching the specified filters.", "enum": [], "example": { "is_on_parent": false } }, { "name": "names", "type": "array", "optional": true, "description": "Names of the privileges. The name of a privilege matches completely with its ID.", "enum": [], "example": [ "web-01" ] }, { "name": "versions", "type": "array", "optional": true, "description": "The versions of the privileges.", "enum": [], "example": [ 1 ] }, { "name": "iterate", "type": "object", "optional": true, "description": "allows to iterate over the set of privileges.", "enum": [], "example": { "page_size": 1, "marker": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Privileges_list" ] }, "GET /api/vcenter/authorization/privileges/{privilege}": { "verb": "GET", "path": "/api/vcenter/authorization/privileges/{privilege}", "query_fields": [], "path_fields": [ { "name": "privilege", "type": "string", "optional": false, "description": "the unique identifier of the privilege.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Privileges_get" ] }, "GET /api/vcenter/authorization/roles": { "verb": "GET", "path": "/api/vcenter/authorization/roles", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Return only roles matching the specified filters.", "enum": [], "example": { "is_system": false } }, { "name": "names", "type": "array", "optional": true, "description": "Names of the roles.", "enum": [], "example": [ "web-01" ] }, { "name": "privileges", "type": "array", "optional": true, "description": "The *Vcenter.Authorization.Privileges* part of the role.", "enum": [], "example": [ "example" ] }, { "name": "iterate", "type": "object", "optional": true, "description": "allows to iterate over the set of roles.", "enum": [], "example": { "page_size": 1, "marker": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Roles_list" ] }, "GET /api/vcenter/authorization/roles/{role}": { "verb": "GET", "path": "/api/vcenter/authorization/roles/{role}", "query_fields": [], "path_fields": [ { "name": "role", "type": "string", "optional": false, "description": "the unique identifier of the role.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.Roles_get" ] }, "GET /api/vcenter/authorization/vt-containers/mappings": { "verb": "GET", "path": "/api/vcenter/authorization/vt-containers/mappings", "query_fields": [ { "name": "vtcontainers", "type": "array", "optional": true, "description": "A set of vTContainers.", "enum": [], "example": [ "example" ] }, { "name": "types", "type": "array", "optional": true, "description": "A set of object resource types.", "enum": [], "example": [ "example" ] }, { "name": "iterate", "type": "object", "optional": true, "description": "The specification of a page to be retrieved.", "enum": [], "example": { "marker": "example", "size": 1 } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.VtContainers.Mappings_list" ] }, "GET /api/vcenter/authorization/vt-containers/mappings/{mapping}": { "verb": "GET", "path": "/api/vcenter/authorization/vt-containers/mappings/{mapping}", "query_fields": [], "path_fields": [ { "name": "mapping", "type": "string", "optional": false, "description": "The mapping identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.VtContainers.Mappings_get" ] }, "GET /api/vcenter/capacity/usage": { "verb": "GET", "path": "/api/vcenter/capacity/usage", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Capacity.Usage_get" ] }, "GET /api/vcenter/certificate-management/vcenter/signing-certificate": { "verb": "GET", "path": "/api/vcenter/certificate-management/vcenter/signing-certificate", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.SigningCertificate_get" ] }, "GET /api/vcenter/certificate-management/vcenter/tls": { "verb": "GET", "path": "/api/vcenter/certificate-management/vcenter/tls", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.Tls_get" ] }, "GET /api/vcenter/certificate-management/vcenter/trusted-root-chains": { "verb": "GET", "path": "/api/vcenter/certificate-management/vcenter/trusted-root-chains", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.TrustedRootChains_list" ] }, "GET /api/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}": { "verb": "GET", "path": "/api/vcenter/certificate-management/vcenter/trusted-root-chains/{chain}", "query_fields": [], "path_fields": [ { "name": "chain", "type": "string", "optional": false, "description": "Unique identifier for a trusted root cert chain.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.TrustedRootChains_get" ] }, "GET /api/vcenter/cluster": { "verb": "GET", "path": "/api/vcenter/cluster", "query_fields": [ { "name": "clusters", "type": "array", "optional": true, "description": "Identifiers of clusters that can match the filter.", "enum": [], "example": [ "domain-c21" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that clusters must have to match the filter (see *Vcenter.Cluster.Info.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the cluster for the cluster to match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the cluster for the cluster to match the filter.", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Cluster_list" ] }, "GET /api/vcenter/cluster/{cluster}": { "verb": "GET", "path": "/api/vcenter/cluster/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Cluster_get" ] }, "GET /api/vcenter/cluster/{cluster}/evc-mode": { "verb": "GET", "path": "/api/vcenter/cluster/{cluster}/evc-mode", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Cluster.EvcMode_get" ] }, "GET /api/vcenter/compute/policies": { "verb": "GET", "path": "/api/vcenter/compute/policies", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies_list" ] }, "GET /api/vcenter/compute/policies/capabilities": { "verb": "GET", "path": "/api/vcenter/compute/policies/capabilities", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies.Capabilities_list" ] }, "GET /api/vcenter/compute/policies/capabilities/{capability}": { "verb": "GET", "path": "/api/vcenter/compute/policies/capabilities/{capability}", "query_fields": [], "path_fields": [ { "name": "capability", "type": "string", "optional": false, "description": "Identifier of the capability for which information should be retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies.Capabilities_get" ] }, "GET /api/vcenter/compute/policies/tag-usage": { "verb": "GET", "path": "/api/vcenter/compute/policies/tag-usage", "query_fields": [ { "name": "policies", "type": "array", "optional": true, "description": "Identifiers that compute policies must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "tags", "type": "array", "optional": true, "description": "Identifiers that tags must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "tag_types", "type": "array", "optional": true, "description": "Identifiers that tag types must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "policy_names", "type": "array", "optional": true, "description": "Names that the policies must have to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "capabilities", "type": "array", "optional": true, "description": "Capabilities that the policies must have to match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies.TagUsage_list" ] }, "GET /api/vcenter/compute/policies/{policy}": { "verb": "GET", "path": "/api/vcenter/compute/policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier of the policy for which information should be retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Compute.Policies_get" ] }, "GET /api/vcenter/consumption-domains/zone-associations/cluster": { "verb": "GET", "path": "/api/vcenter/consumption-domains/zone-associations/cluster", "query_fields": [ { "name": "clusters", "type": "array", "optional": true, "description": "Zone-cluster associations will be filtered such that each association that is returned will have a cluster identifier from this set of specified cluster iden...", "enum": [], "example": [ "domain-c21" ] }, { "name": "zones", "type": "array", "optional": true, "description": "Zone-cluster associations will be filtered such that each association that is returned will have a zone identifier from this set of specified zone identifiers.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.ZoneAssociations.Cluster_list" ] }, "GET /api/vcenter/consumption-domains/zones": { "verb": "GET", "path": "/api/vcenter/consumption-domains/zones", "query_fields": [ { "name": "zones", "type": "array", "optional": true, "description": "Matches all zones corresponding to the specified set of zone identifiers.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones_list" ] }, "GET /api/vcenter/consumption-domains/zones/cluster/{zone}/associations": { "verb": "GET", "path": "/api/vcenter/consumption-domains/zones/cluster/{zone}/associations", "query_fields": [], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone to be queried for its associated vSphere clusters.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones.Cluster.Associations_get" ] }, "GET /api/vcenter/consumption-domains/zones/{zone}": { "verb": "GET", "path": "/api/vcenter/consumption-domains/zones/{zone}", "query_fields": [], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone for which information should be retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones_get" ] }, "GET /api/vcenter/consumption-domains/zones/{zone}/capacity/summary": { "verb": "GET", "path": "/api/vcenter/consumption-domains/zones/{zone}/capacity/summary", "query_fields": [], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone from which to retrieve the resource capacity.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones.Capacity.Summary_get" ] }, "GET /api/vcenter/content/registries/harbor": { "verb": "GET", "path": "/api/vcenter/content/registries/harbor", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor_list" ] }, "GET /api/vcenter/content/registries/harbor/{registry}": { "verb": "GET", "path": "/api/vcenter/content/registries/harbor/{registry}", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor_get" ] }, "GET /api/vcenter/content/registries/harbor/{registry}/projects": { "verb": "GET", "path": "/api/vcenter/content/registries/harbor/{registry}/projects", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor.Projects_list" ] }, "GET /api/vcenter/content/registries/harbor/{registry}/projects/{project}": { "verb": "GET", "path": "/api/vcenter/content/registries/harbor/{registry}/projects/{project}", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" }, { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Harbor project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor.Projects_get" ] }, "GET /api/vcenter/content/registries/{registry}/health": { "verb": "GET", "path": "/api/vcenter/content/registries/{registry}/health", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Health_get" ] }, "GET /api/vcenter/crypto-manager/hosts/{host}/kms/providers": { "verb": "GET", "path": "/api/vcenter/crypto-manager/hosts/{host}/kms/providers", "query_fields": [ { "name": "providers", "type": "array", "optional": true, "description": "Provider identifiers.", "enum": [], "example": [ "example" ] }, { "name": "health", "type": "array", "optional": true, "description": "Provider health status.", "enum": [], "example": [ "example" ] }, { "name": "types", "type": "array", "optional": true, "description": "Provider types.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CryptoManager.Hosts.Kms.Providers_list" ] }, "GET /api/vcenter/crypto-manager/hosts/{host}/kms/providers/{provider}": { "verb": "GET", "path": "/api/vcenter/crypto-manager/hosts/{host}/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Host identifier.", "enum": [], "example": "host-11" }, { "name": "provider", "type": "string", "optional": false, "description": "Provider identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CryptoManager.Hosts.Kms.Providers_get" ] }, "GET /api/vcenter/crypto-manager/kms/providers": { "verb": "GET", "path": "/api/vcenter/crypto-manager/kms/providers", "query_fields": [ { "name": "providers", "type": "array", "optional": true, "description": "Provider identifiers.", "enum": [], "example": [ "example" ] }, { "name": "health", "type": "array", "optional": true, "description": "Provider health status.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CryptoManager.Kms.Providers_list" ] }, "GET /api/vcenter/crypto-manager/kms/providers/{provider}": { "verb": "GET", "path": "/api/vcenter/crypto-manager/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CryptoManager.Kms.Providers_get" ] }, "GET /api/vcenter/crypto/fips/modules": { "verb": "GET", "path": "/api/vcenter/crypto/fips/modules", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Crypto.Fips.Modules_list" ] }, "GET /api/vcenter/datacenter": { "verb": "GET", "path": "/api/vcenter/datacenter", "query_fields": [ { "name": "datacenters", "type": "array", "optional": true, "description": "Identifiers of datacenters that can match the filter.", "enum": [], "example": [ "datacenter-21" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that datacenters must have to match the filter (see *Vcenter.Datacenter.Info.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the datacenters for the datacenter to match the filter.", "enum": [], "example": [ "group-v23" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datacenter_list" ] }, "GET /api/vcenter/datacenter/{datacenter}": { "verb": "GET", "path": "/api/vcenter/datacenter/{datacenter}", "query_fields": [], "path_fields": [ { "name": "datacenter", "type": "string", "optional": false, "description": "Identifier of the datacenter.", "enum": [], "example": "datacenter-21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datacenter_get" ] }, "GET /api/vcenter/datastore": { "verb": "GET", "path": "/api/vcenter/datastore", "query_fields": [ { "name": "datastores", "type": "array", "optional": true, "description": "Identifiers of datastores that can match the filter.", "enum": [], "example": [ "datastore-31" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that datastores must have to match the filter (see *Vcenter.Datastore.Info.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "types", "type": "array", "optional": true, "description": "Types that datastores must have to match the filter (see *Vcenter.Datastore.Summary.type*).", "enum": [], "example": [ "example" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the datastore for the datastore to match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the datastore for the datastore to match the filter.", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datastore_list" ] }, "GET /api/vcenter/datastore/{datastore}": { "verb": "GET", "path": "/api/vcenter/datastore/{datastore}", "query_fields": [], "path_fields": [ { "name": "datastore", "type": "string", "optional": false, "description": "Identifier of the datastore for which information should be retrieved.", "enum": [], "example": "datastore-31" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datastore_get" ] }, "GET /api/vcenter/datastore/{datastore}/default-policy": { "verb": "GET", "path": "/api/vcenter/datastore/{datastore}/default-policy", "query_fields": [], "path_fields": [ { "name": "datastore", "type": "string", "optional": false, "description": "Identifier of the datastore for which the default policy is requested.", "enum": [], "example": "datastore-31" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Datastore.DefaultPolicy_get" ] }, "GET /api/vcenter/deployment": { "verb": "GET", "path": "/api/vcenter/deployment", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment_get" ] }, "GET /api/vcenter/deployment/history": { "verb": "GET", "path": "/api/vcenter/deployment/history", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.ImportHistory_get" ] }, "GET /api/vcenter/deployment/install": { "verb": "GET", "path": "/api/vcenter/deployment/install", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install_get" ] }, "GET /api/vcenter/deployment/install/initial-config/remote-psc/thumbprint": { "verb": "GET", "path": "/api/vcenter/deployment/install/initial-config/remote-psc/thumbprint", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Information used to connect to the remote PSC.", "enum": [], "example": { "address": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install.InitialConfig.RemotePsc.Thumbprint_get" ] }, "GET /api/vcenter/deployment/migrate": { "verb": "GET", "path": "/api/vcenter/deployment/migrate", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Migrate_get" ] }, "GET /api/vcenter/deployment/question": { "verb": "GET", "path": "/api/vcenter/deployment/question", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Question_get" ] }, "GET /api/vcenter/deployment/size": { "verb": "GET", "path": "/api/vcenter/deployment/size", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Size_get" ] }, "GET /api/vcenter/deployment/size/status": { "verb": "GET", "path": "/api/vcenter/deployment/size/status", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Size.Status_get" ] }, "GET /api/vcenter/deployment/upgrade": { "verb": "GET", "path": "/api/vcenter/deployment/upgrade", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Upgrade_get" ] }, "GET /api/vcenter/environment-browser/config-option-descriptors": { "verb": "GET", "path": "/api/vcenter/environment-browser/config-option-descriptors", "query_fields": [ { "name": "clusters", "type": "array", "optional": true, "description": "A set of Cluster IDs that specify for which Clusters the configuration option descriptors are requested.", "enum": [], "example": [ "domain-c21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.EnvironmentBrowser.ConfigOptionDescriptors_list" ] }, "GET /api/vcenter/environment-browser/config-options": { "verb": "GET", "path": "/api/vcenter/environment-browser/config-options", "query_fields": [ { "name": "params", "type": "object", "optional": false, "description": "The query specification used to provide key, guest OS identifier(s), clusters.", "enum": [], "example": { "config_option": "example" } }, { "name": "clusters", "type": "array", "optional": true, "description": "The clusters whose config option are requested.", "enum": [], "example": [ "domain-c21" ] }, { "name": "guest_ids", "type": "array", "optional": true, "description": "Filter the set of Guest OSs for which descriptors will be returned.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.EnvironmentBrowser.ConfigOptions_get" ] }, "GET /api/vcenter/environment-browser/config-targets": { "verb": "GET", "path": "/api/vcenter/environment-browser/config-targets", "query_fields": [ { "name": "clusters", "type": "array", "optional": true, "description": "A set of Cluster IDs that specify for which Clusters the configuration target is requested.", "enum": [], "example": [ "domain-c21" ] }, { "name": "filter", "type": "array", "optional": true, "description": "Specify a filter to narrow the results.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.EnvironmentBrowser.ConfigTargets_get" ] }, "GET /api/vcenter/folder": { "verb": "GET", "path": "/api/vcenter/folder", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching folders for which information should be returned.", "enum": [], "example": { "type": "example" } }, { "name": "folders", "type": "array", "optional": true, "description": "Identifiers of folders that can match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that folders must have to match the filter (see *Vcenter.Folder.Summary.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "parent_folders", "type": "array", "optional": true, "description": "Folders that must contain the folder for the folder to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the folder for the folder to match the filter.", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Folder_list" ] }, "GET /api/vcenter/foundation-load-balancers": { "verb": "GET", "path": "/api/vcenter/foundation-load-balancers", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "specification of matching load balancers for which information should be returned.", "enum": [], "example": { "name": "web-01" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers_list" ] }, "GET /api/vcenter/foundation-load-balancers/{foundationLoadBalancer}": { "verb": "GET", "path": "/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}", "query_fields": [], "path_fields": [ { "name": "foundationLoadBalancer", "type": "string", "optional": false, "description": "identifier of the load balancer.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers_get" ] }, "GET /api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes": { "verb": "GET", "path": "/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes", "query_fields": [], "path_fields": [ { "name": "foundationLoadBalancer", "type": "string", "optional": false, "description": "identifier of load balancer.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers.Nodes_list" ] }, "GET /api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes/{nodeId}": { "verb": "GET", "path": "/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes/{nodeId}", "query_fields": [], "path_fields": [ { "name": "foundationLoadBalancer", "type": "string", "optional": false, "description": "identifier of the load balancer.", "enum": [], "example": "example" }, { "name": "nodeId", "type": "string", "optional": false, "description": "identifier of load balancer node to get information.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers.Nodes_get" ] }, "GET /api/vcenter/guest/customization-specs": { "verb": "GET", "path": "/api/vcenter/guest/customization-specs", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching guest customization specifications for which information should be returned.", "enum": [], "example": { "os_type": "example" } }, { "name": "names", "type": "array", "optional": true, "description": "Names that guest customization specifications must have to match the filter (see *Vcenter.Guest.CustomizationSpecs.Summary.name*).", "enum": [], "example": [ "web-01" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_list" ] }, "GET /api/vcenter/guest/customization-specs/{name}": { "verb": "GET", "path": "/api/vcenter/guest/customization-specs/{name}", "query_fields": [], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "The name of the customization specification.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_get" ] }, "GET /api/vcenter/host": { "verb": "GET", "path": "/api/vcenter/host", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching hosts for which information should be returned.", "enum": [], "example": { "standalone": false } }, { "name": "hosts", "type": "array", "optional": true, "description": "Identifiers of hosts that can match the filter.", "enum": [], "example": [ "host-11" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that hosts must have to match the filter (see *Vcenter.Host.Summary.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the hosts for the hosts to match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the hosts for the hosts to match the filter.", "enum": [], "example": [ "datacenter-21" ] }, { "name": "clusters", "type": "array", "optional": true, "description": "Clusters that must contain the hosts for the hosts to match the filter.", "enum": [], "example": [ "domain-c21" ] }, { "name": "connection_states", "type": "array", "optional": true, "description": "Connection states that a host must be in to match the filter (see *Vcenter.Host.Summary.connection_state*.", "enum": [], "example": [ "example" ] }, { "name": "host_uuids", "type": "array", "optional": true, "description": "UUID of hosts that can match the filter. Maps to \"UUID\" in SMBIOS: System Information (Type 1) and offset 08h", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host_list" ] }, "GET /api/vcenter/host/crypto/fips/modules": { "verb": "GET", "path": "/api/vcenter/host/crypto/fips/modules", "query_fields": [ { "name": "hosts", "type": "array", "optional": true, "description": "MoId of the hosts whose modules shall be included in the result; Up to 100 hosts can be specified.", "enum": [], "example": [ "host-11" ] }, { "name": "names", "type": "array", "optional": true, "description": "Name of modules which shall be included in the result. Up to 10 names can be specified.", "enum": [], "example": [ "web-01" ] }, { "name": "versions", "type": "array", "optional": true, "description": "Version of modules which shall be included in the result. Up to 10 versions can be specified.", "enum": [], "example": [ "example" ] }, { "name": "iterate", "type": "object", "optional": true, "description": "optional specification for pagination of results.", "enum": [], "example": { "marker": "example", "page_size": 1 } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host.Crypto.Fips.Modules_list" ] }, "GET /api/vcenter/host/{host}/entropy/external-pool": { "verb": "GET", "path": "/api/vcenter/host/{host}/entropy/external-pool", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host.Entropy.ExternalPool_get" ] }, "GET /api/vcenter/host/{host}/hardware/direct-path-devices": { "verb": "GET", "path": "/api/vcenter/host/{host}/hardware/direct-path-devices", "query_fields": [ { "name": "devices", "type": "array", "optional": true, "description": "Set of device IDs to query.", "enum": [], "example": [ "example" ] }, { "name": "iterationSpec", "type": "object", "optional": true, "description": "Allows clients to iterate over the results.", "enum": [], "example": { "page_size": 1, "marker": "example" } }, { "name": "listDetails", "type": "object", "optional": true, "description": "Allows clients to request additional data to be included in the *GET /vcenter/host/{host}/hardware/direct-path-devices* operation output.", "enum": [], "example": { "vm_class": false } } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host to be queried for its DirectPath devices.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host.Hardware.DirectPathDevices_list" ] }, "GET /api/vcenter/identity/broker/tenants/operator-client": { "verb": "GET", "path": "/api/vcenter/identity/broker/tenants/operator-client", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Identity.Broker.Tenants.OperatorClient_get" ] }, "GET /api/vcenter/identity/broker/tenants/{tenant}/admin-client": { "verb": "GET", "path": "/api/vcenter/identity/broker/tenants/{tenant}/admin-client", "query_fields": [], "path_fields": [ { "name": "tenant", "type": "string", "optional": false, "description": "The tenant name for which the admin client token needs to be returned.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Identity.Broker.Tenants.AdminClient_get" ] }, "GET /api/vcenter/identity/providers": { "verb": "GET", "path": "/api/vcenter/identity/providers", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Identity.Providers_list" ] }, "GET /api/vcenter/identity/providers/{provider}": { "verb": "GET", "path": "/api/vcenter/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "the identifier of the provider", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Identity.Providers_get" ] }, "GET /api/vcenter/inventory/datastore": { "verb": "GET", "path": "/api/vcenter/inventory/datastore", "query_fields": [ { "name": "datastores", "type": "array", "optional": false, "description": "Identifiers of the datastores for which information will be returned.", "enum": [], "example": [ "datastore-31" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Inventory.Datastore_find" ] }, "GET /api/vcenter/inventory/network": { "verb": "GET", "path": "/api/vcenter/inventory/network", "query_fields": [ { "name": "networks", "type": "array", "optional": false, "description": "Identifiers of the vCenter Server networks for which information will be returned.", "enum": [], "example": [ "network-41" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Inventory.Network_find" ] }, "GET /api/vcenter/lcm/deployment/migration-upgrade": { "verb": "GET", "path": "/api/vcenter/lcm/deployment/migration-upgrade", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Deployment.MigrationUpgrade_get" ] }, "GET /api/vcenter/lcm/deployment/migration-upgrade/planned-downtime": { "verb": "GET", "path": "/api/vcenter/lcm/deployment/migration-upgrade/planned-downtime", "query_fields": [ { "name": "duration", "type": "integer", "optional": false, "description": "number of minutes to check from current moment", "enum": [], "example": 1 } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Deployment.MigrationUpgrade.PlannedDowntime_get" ] }, "GET /api/vcenter/lcm/deployment/migration-upgrade/status": { "verb": "GET", "path": "/api/vcenter/lcm/deployment/migration-upgrade/status", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Deployment.MigrationUpgrade.Status_get" ] }, "GET /api/vcenter/lcm/deployment/repository": { "verb": "GET", "path": "/api/vcenter/lcm/deployment/repository", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Deployment.Repository_get" ] }, "GET /api/vcenter/lcm/depot/services": { "verb": "GET", "path": "/api/vcenter/lcm/depot/services", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Depot.Services_get" ] }, "GET /api/vcenter/lcm/depot/services/{serviceType}": { "verb": "GET", "path": "/api/vcenter/lcm/depot/services/{serviceType}", "query_fields": [], "path_fields": [ { "name": "serviceType", "type": "string", "optional": false, "description": "specific external service type.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Depot.Services_getServiceSpec" ] }, "GET /api/vcenter/lcm/discovery/associated-products": { "verb": "GET", "path": "/api/vcenter/lcm/discovery/associated-products", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Discovery.AssociatedProducts_list" ] }, "GET /api/vcenter/lcm/discovery/associated-products/{product}": { "verb": "GET", "path": "/api/vcenter/lcm/discovery/associated-products/{product}", "query_fields": [], "path_fields": [ { "name": "product", "type": "string", "optional": false, "description": "An identifier of the product to be modified.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Discovery.AssociatedProducts_get" ] }, "GET /api/vcenter/lcm/discovery/product-catalog": { "verb": "GET", "path": "/api/vcenter/lcm/discovery/product-catalog", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Discovery.ProductCatalog_list" ] }, "GET /api/vcenter/lcm/reports/{report}": { "verb": "GET", "path": "/api/vcenter/lcm/reports/{report}", "query_fields": [], "path_fields": [ { "name": "report", "type": "string", "optional": false, "description": "The parameter must be an identifier for the resource type: `com.vmware.vcenter.lcm.report`.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Reports_get" ] }, "GET /api/vcenter/lcm/update/pending": { "verb": "GET", "path": "/api/vcenter/lcm/update/pending", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Update.Pending_list" ] }, "GET /api/vcenter/lcm/update/pending/{version}": { "verb": "GET", "path": "/api/vcenter/lcm/update/pending/{version}", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "A version identified the update", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Update.Pending_get" ] }, "GET /api/vcenter/namespace-management/capability": { "verb": "GET", "path": "/api/vcenter/namespace-management/capability", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.HostsConfig_get" ] }, "GET /api/vcenter/namespace-management/cluster-compatibility": { "verb": "GET", "path": "/api/vcenter/namespace-management/cluster-compatibility", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching clusters for which information should be returned.", "enum": [], "example": { "compatible": false, "network_provider": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.ClusterCompatibility_list" ] }, "GET /api/vcenter/namespace-management/cluster-compatibility/v2": { "verb": "GET", "path": "/api/vcenter/namespace-management/cluster-compatibility/v2", "query_fields": [ { "name": "zones", "type": "array", "optional": true, "description": "A list of vSphere Zone identifiers which will be used to filter vSphere Zones that correspond to this specific set of identifiers.", "enum": [], "example": [ "example" ] }, { "name": "clusterFilter", "type": "object", "optional": true, "description": "Specification of matching vSphere clusters for which information should be returned.", "enum": [], "example": { "compatible": false, "network_provider": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.ClusterCompatibility_listV2" ] }, "GET /api/vcenter/namespace-management/cluster-size-info": { "verb": "GET", "path": "/api/vcenter/namespace-management/cluster-size-info", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.ClusterSizeInfo_get" ] }, "GET /api/vcenter/namespace-management/clusters": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters_list" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters_get" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/load-balancers": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/load-balancers", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster the load balancers are associated with.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.LoadBalancers_list" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster the load balancer is associated with.", "enum": [], "example": "domain-c21" }, { "name": "id", "type": "string", "optional": false, "description": "Identifier of the load balancer *Vcenter.NamespaceManagement.LoadBalancers.ConfigSpec.id*.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.LoadBalancers_get" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/networks": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_list" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/networks/{network}": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the vSphere Namespaces network.", "enum": [], "example": "network-41" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_get" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/supervisor-services": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster from which to list the service summaries.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.ClusterSupervisorServices_list" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster from which to get the service information.", "enum": [], "example": "domain-c21" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.ClusterSupervisorServices_get" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/topology": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/topology", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for a vSphere Cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters.Topology_get" ] }, "GET /api/vcenter/namespace-management/clusters/{cluster}/workload-resource-options": { "verb": "GET", "path": "/api/vcenter/namespace-management/clusters/{cluster}/workload-resource-options", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster hosting the namespace on which the resource quota needs to be set.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.NamespaceResourceOptions_get" ] }, "GET /api/vcenter/namespace-management/distributed-switch-compatibility": { "verb": "GET", "path": "/api/vcenter/namespace-management/distributed-switch-compatibility", "query_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of a vCenter Cluster. Only Distributed Switches associated with the vCenter Cluster will be considered by the filter.", "enum": [], "example": "domain-c21" }, { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Distributed Switches for which information should be returned.", "enum": [], "example": { "compatible": false, "network_provider": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.DistributedSwitchCompatibility_list" ] }, "GET /api/vcenter/namespace-management/edge-cluster-compatibility": { "verb": "GET", "path": "/api/vcenter/namespace-management/edge-cluster-compatibility", "query_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of a vCenter Cluster. Only Edge Clusters that are associated with the particular vCenter Cluster will be considered by the filter.", "enum": [], "example": "domain-c21" }, { "name": "distributed_switch", "type": "string", "optional": false, "description": "Identifier of a Distributed Switch. Only Edge Clusters that are associated with the particular Distributed Switch will be considered by the filter.", "enum": [], "example": "example" }, { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Edge Clusters for which information should be returned.", "enum": [], "example": { "compatible": false } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.EdgeClusterCompatibility_list" ] }, "GET /api/vcenter/namespace-management/infrastructure-policies": { "verb": "GET", "path": "/api/vcenter/namespace-management/infrastructure-policies", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.InfrastructurePolicies_list" ] }, "GET /api/vcenter/namespace-management/infrastructure-policies/{policy}": { "verb": "GET", "path": "/api/vcenter/namespace-management/infrastructure-policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier for the policy.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.InfrastructurePolicies_get" ] }, "GET /api/vcenter/namespace-management/lifecycle/content/libraries": { "verb": "GET", "path": "/api/vcenter/namespace-management/lifecycle/content/libraries", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Lifecycle.Content.Libraries_list" ] }, "GET /api/vcenter/namespace-management/lifecycle/content/libraries/{library}": { "verb": "GET", "path": "/api/vcenter/namespace-management/lifecycle/content/libraries/{library}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier for the Content Library.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Lifecycle.Content.Libraries_get" ] }, "GET /api/vcenter/namespace-management/networks/nsx/distributed-switches": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/distributed-switches", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Distributed Switches for which information should be returned.", "enum": [], "example": { "compatible": false, "cluster": "domain-c21" } }, { "name": "zones", "type": "array", "optional": true, "description": "Zone compatibility criteria. If zones are specified, the common distributed switches across the given zones will returned. A distributed switch is considered...", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.DistributedSwitches_list" ] }, "GET /api/vcenter/namespace-management/networks/nsx/edges": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/edges", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Edges for which information should be returned.", "enum": [], "example": { "compatible": false } }, { "name": "distributed_switch", "type": "array", "optional": true, "description": "Distributed switch UUID criteria. If distributed switches identifiers are specified, they will be used to filter the Edges. To obtain the available distribut...", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Edges_list" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Projects for which information should be returned.", "enum": [], "example": { "compatible": false } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects_list" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects/{project}": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects_get" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching Profiles for which information should be returned.", "enum": [], "example": { "compatible": false } } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.VpcConnectivityProfiles_list" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles/{profile}": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles/{profile}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" }, { "name": "profile", "type": "string", "optional": false, "description": "Identifier of the VPC Connectivity Profile.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.VpcConnectivityProfiles_get" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs", "query_fields": [ { "name": "filter", "type": "object", "optional": false, "description": "Specification of matching VPCs for which information should be returned.", "enum": [], "example": { "supervisor": "example", "compatible": false } } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.Vpcs_list" ] }, "GET /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs/{vpc}": { "verb": "GET", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs/{vpc}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" }, { "name": "vpc", "type": "string", "optional": false, "description": "Identifier of the VPC.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.Vpcs_get" ] }, "GET /api/vcenter/namespace-management/nsx-tier0-gateways": { "verb": "GET", "path": "/api/vcenter/namespace-management/nsx-tier0-gateways", "query_fields": [ { "name": "distributed_switch", "type": "string", "optional": false, "description": "Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distribu...", "enum": [], "example": "example" }, { "name": "filter", "type": "object", "optional": true, "description": "Additional specification of matching NSXTier0Gateway for which information should be returned.", "enum": [], "example": { "include_vrf": false } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.NSXTier0Gateway_list" ] }, "GET /api/vcenter/namespace-management/software/cluster-available-versions": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/cluster-available-versions", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.ClusterAvailableVersions_list" ] }, "GET /api/vcenter/namespace-management/software/clusters": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/clusters", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Clusters_list" ] }, "GET /api/vcenter/namespace-management/software/clusters/{cluster}": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster which will be upgraded.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Clusters_get" ] }, "GET /api/vcenter/namespace-management/software/supervisors/upgrades": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/upgrades", "query_fields": [ { "name": "supervisors", "type": "array", "optional": true, "description": "Identifiers of Supervisors to filter the upgrade summaries.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Upgrades_list" ] }, "GET /api/vcenter/namespace-management/software/supervisors/upgrades/{supervisor}": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/upgrades/{supervisor}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor which will be upgraded.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Upgrades_get" ] }, "GET /api/vcenter/namespace-management/software/supervisors/versions": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/versions", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Optional specification to constrain the candidate versions returned.", "enum": [], "example": { "cluster_compute_resource": "example", "network_provider": "example" } }, { "name": "zones", "type": "array", "optional": true, "description": "The vSphere Zones for which the compatibility of a Supervisor version is being checked.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Versions_list" ] }, "GET /api/vcenter/namespace-management/software/supervisors/versions/{version}": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/versions/{version}", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Identifier of the Supervisor version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Versions_get" ] }, "GET /api/vcenter/namespace-management/software/supervisors/versions/{version}/control-plane/sizes": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/versions/{version}/control-plane/sizes", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Version string for which sizes are being queried.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Versions.ControlPlane.Sizes_list" ] }, "GET /api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks": { "verb": "GET", "path": "/api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "target_version", "type": "string", "description": "target_version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "target_version": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Prechecks_get" ] }, "GET /api/vcenter/namespace-management/stats/time-series": { "verb": "GET", "path": "/api/vcenter/namespace-management/stats/time-series", "query_fields": [ { "name": "spec", "type": "object", "optional": false, "description": "Specification of the statistical values that should be returned.", "enum": [], "example": { "start": 1, "end": 1, "obj_type": "example" } }, { "name": "pod-namespace", "type": "string", "optional": true, "description": "The namespace that the pod is running in.", "enum": [], "example": "example" }, { "name": "pod_name", "type": "string", "optional": true, "description": "The name of the pod itself.", "enum": [], "example": "example" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Stats.TimeSeries_get" ] }, "GET /api/vcenter/namespace-management/supervisor-services": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisor-services", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices_list" ] }, "GET /api/vcenter/namespace-management/supervisor-services/{supervisorService}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices_get" ] }, "GET /api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier of the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.Versions_list" ] }, "GET /api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier of the Supervisor Service.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Identifier of the version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.Versions_get" ] }, "GET /api/vcenter/namespace-management/supervisors/recovery/backup/archives": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/recovery/backup/archives", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Set of parameters that can be used to constrain the results of the operation.", "enum": [], "example": { "archive": "example", "usable": false } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Recovery.Backup.Archives_list" ] }, "GET /api/vcenter/namespace-management/supervisors/summaries": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/summaries", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Set of parameters that can be used to constrain the results of the operation.", "enum": [], "example": { "config_status": "example", "kubernetes_status": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Summary_list" ] }, "GET /api/vcenter/namespace-management/supervisors/supervisor-services/signatures": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/supervisor-services/signatures", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of filtering criteria used to match Supervisor Services for which signature information should be returned.", "enum": [], "example": { "supervisor": "example", "service": "example", "version": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices.Signatures_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/capabilities": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/capabilities", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Capabilities_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/certificates": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/certificates", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "parameters on which to filter response contents.", "enum": [], "example": { "endpoint": "example" } } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the certificates are being retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Certificates_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/certificates/key-sizes": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/certificates/key-sizes", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Certificates.KeySizes_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/conditions": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/conditions", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the identifier for a Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Conditions_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which the container image registry is created.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ContainerImageRegistries_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which the container image registry is created.", "enum": [], "example": "example" }, { "name": "containerImageRegistry", "type": "string", "optional": false, "description": "Identifier for the container image registry.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ContainerImageRegistries_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/networks/settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/networks/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Networks.Settings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Settings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/storage/policies": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/storage/policies", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Storage.Policies_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/crypto/fips/modules": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/crypto/fips/modules", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Crypto.Fips.Modules_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/identity/domains": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/domains", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the Supervisor for which identity domains are being listed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Domains_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/identity/domains/{domain}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/domains/{domain}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the identity domain is being read.", "enum": [], "example": "example" }, { "name": "domain", "type": "string", "optional": false, "description": "identifier for the supervisor identity domain that is being read.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Domains_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the Supervisor for which identity providers are being listed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the identity provider is being read.", "enum": [], "example": "example" }, { "name": "provider", "type": "string", "optional": false, "description": "identifier for the identity provider that is being read.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/logs/agent-configuration": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/logs/agent-configuration", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier of the Supervisor whose log streaming configuration is being retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Logs.AgentConfiguration_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/management-services": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/management-services", "query_fields": [ { "name": "management_services", "type": "array", "optional": true, "description": "Identifiers of Management Services.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ManagementServices_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" }, { "name": "managementService", "type": "string", "optional": false, "description": "Identifier of the Management Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ManagementServices_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the remote endpoints are being retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the remote endpoint is being retrieved.", "enum": [], "example": "example" }, { "name": "remoteEndpoint", "type": "string", "optional": false, "description": "identifier of the remote endpoint that is being retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/networks": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges", "query_fields": [ { "name": "providers", "type": "array", "optional": true, "description": "Filter by one or more edge providers.", "enum": [], "example": [ "example" ] }, { "name": "edges", "type": "array", "optional": true, "description": "Filter by one or more unique edge identifiers.", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Filter by one or more unique edge names.", "enum": [], "example": [ "web-01" ] } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "The unique identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks.Edges_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the Supervisor network.", "enum": [], "example": "network-41" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/storage/cloud-native/resource-checks": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/storage/cloud-native/resource-checks", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "operation", "type": "string", "description": "operation", "optional": true, "enum": [], "example": "example" } ], "body_example": { "operation": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Storage.CloudNative.ResourceChecks_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/summary": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/summary", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the identifier for a supervisor", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Summary_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-service-settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-service-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServiceSettings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_list" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}/versions/{targetVersion}/precheck": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}/versions/{targetVersion}/precheck", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" }, { "name": "targetVersion", "type": "string", "optional": false, "description": "Identifier for the target version to run the pre-check with.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_getPrecheckResult" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}/{version}/signatures": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}/{version}/signatures", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices.Signatures_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/topology": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/topology", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for a Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Topology_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/vsphere-pod-settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/vsphere-pod-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.VspherePodSettings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/images/settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/images/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Images.Settings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/kube-api-server-settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/kube-api-server-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.KubeApiServerSettings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/networks/settings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/networks/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Networks.Settings_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/cloud-native/file-volumes": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/cloud-native/file-volumes", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Storage.CloudNative.FileVolumes_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/policies": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/policies", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Storage.Policies_get" ] }, "GET /api/vcenter/namespace-management/supervisors/{supervisor}/zones/bindings": { "verb": "GET", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/zones/bindings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Zones.Bindings_list" ] }, "GET /api/vcenter/namespace-management/virtual-machine-classes": { "verb": "GET", "path": "/api/vcenter/namespace-management/virtual-machine-classes", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.VirtualMachineClasses_list" ] }, "GET /api/vcenter/namespace-management/virtual-machine-classes/{vm_class}": { "verb": "GET", "path": "/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}", "query_fields": [], "path_fields": [ { "name": "vm_class", "type": "string", "optional": false, "description": "Identifier for the VM class.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.VirtualMachineClasses_get" ] }, "GET /api/vcenter/namespaces-user/namespaces": { "verb": "GET", "path": "/api/vcenter/namespaces-user/namespaces", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "Specification of matching principals for which namespaces should be returned.", "enum": [], "example": { "username": "example" } }, { "name": "groups", "type": "array", "optional": true, "description": "List of group names.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.User.Instances_list" ] }, "GET /api/vcenter/namespaces/instances": { "verb": "GET", "path": "/api/vcenter/namespaces/instances", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances_list" ] }, "GET /api/vcenter/namespaces/instances/v2": { "verb": "GET", "path": "/api/vcenter/namespaces/instances/v2", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances_listV2" ] }, "GET /api/vcenter/namespaces/instances/v2/{namespace}": { "verb": "GET", "path": "/api/vcenter/namespaces/instances/v2/{namespace}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances_getV2" ] }, "GET /api/vcenter/namespaces/instances/{namespace}": { "verb": "GET", "path": "/api/vcenter/namespaces/instances/{namespace}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Instances_get" ] }, "GET /api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}": { "verb": "GET", "path": "/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}", "query_fields": [ { "name": "type", "type": "string", "optional": false, "description": "The type of subject (USER or GROUP).", "enum": [], "example": "example" } ], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "domain", "type": "string", "optional": false, "description": "The domain of the subject.", "enum": [], "example": "example" }, { "name": "subject", "type": "string", "optional": false, "description": "The principal for this operation.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Access_get" ] }, "GET /api/vcenter/namespaces/namespace-self-service": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-self-service", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceSelfService_list" ] }, "GET /api/vcenter/namespaces/namespace-self-service/{cluster}": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-self-service/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceSelfService_get" ] }, "GET /api/vcenter/namespaces/namespace-templates/clusters/{cluster}": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-templates/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_list" ] }, "GET /api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" }, { "name": "template", "type": "string", "optional": false, "description": "Name of the namespace template.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_get" ] }, "GET /api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_listV2" ] }, "GET /api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}/{template}": { "verb": "GET", "path": "/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}/{template}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "template", "type": "string", "optional": false, "description": "Name of the namespace template.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_getV2" ] }, "GET /api/vcenter/namespaces/{namespace}/management-services/access-grants": { "verb": "GET", "path": "/api/vcenter/namespaces/{namespace}/management-services/access-grants", "query_fields": [ { "name": "management_services", "type": "array", "optional": true, "description": "Identifiers of Management Services.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier of the Namespace.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.ManagementServices.AccessGrants_list" ] }, "GET /api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}": { "verb": "GET", "path": "/api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier of the Namespace.", "enum": [], "example": "example" }, { "name": "accessGrant", "type": "string", "optional": false, "description": "Identifier of the Access Grant.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.ManagementServices.AccessGrants_get" ] }, "GET /api/vcenter/namespaces/{namespace}/mobility/virtualmachines/imports/{task}": { "verb": "GET", "path": "/api/vcenter/namespaces/{namespace}/mobility/virtualmachines/imports/{task}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "task", "type": "string", "optional": false, "description": "Task identifier for the Import.", "enum": [], "example": "task-1" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Mobility.Virtualmachines.Imports_get" ] }, "GET /api/vcenter/namespaces/{namespace}/networks/nsx/subnets": { "verb": "GET", "path": "/api/vcenter/namespaces/{namespace}/networks/nsx/subnets", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the Namespace.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.Networks.Nsx.Subnets_list" ] }, "GET /api/vcenter/network": { "verb": "GET", "path": "/api/vcenter/network", "query_fields": [ { "name": "networks", "type": "array", "optional": true, "description": "Identifiers of networks that can match the filter.", "enum": [], "example": [ "network-41" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that networks must have to match the filter (see *Vcenter.Network.Summary.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "types", "type": "array", "optional": true, "description": "Types that networks must have to match the filter (see *Vcenter.Network.Summary.type*).", "enum": [], "example": [ "example" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the network for the network to match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the network for the network to match the filter.", "enum": [], "example": [ "datacenter-21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network_list" ] }, "GET /api/vcenter/network/projects": { "verb": "GET", "path": "/api/vcenter/network/projects", "query_fields": [ { "name": "ids", "type": "array", "optional": true, "description": "Identifiers that projects must have to match the filter (see *Vcenter.Network.Projects.ProjectInfo.id*).", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that projects must have to match the filter (see *Vcenter.Network.Projects.ProjectInfo.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "external_ids", "type": "array", "optional": true, "description": "External identifiers that projects must have to match the filter (see *Vcenter.Network.Projects.ProjectInfo.external_id*).", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects_list" ] }, "GET /api/vcenter/network/projects/{project}": { "verb": "GET", "path": "/api/vcenter/network/projects/{project}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects_get" ] }, "GET /api/vcenter/network/projects/{project}/vpcs": { "verb": "GET", "path": "/api/vcenter/network/projects/{project}/vpcs", "query_fields": [ { "name": "ids", "type": "array", "optional": true, "description": "Identifiers that VPC must have to match the filter (see *Vcenter.Network.Projects.Vpcs.VpcInfo.id*).", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that VPC must have to match the filter (see *Vcenter.Network.Projects.Vpcs.VpcInfo.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "external_ids", "type": "array", "optional": true, "description": "External identifiers that VPC must have to match the filter (see *Vcenter.Network.Projects.Vpcs.VpcInfo.external_id*).", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the project to which the VPC belongs.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects.Vpcs_list" ] }, "GET /api/vcenter/network/projects/{project}/vpcs/{vpc}": { "verb": "GET", "path": "/api/vcenter/network/projects/{project}/vpcs/{vpc}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the project to which the VPC belongs.", "enum": [], "example": "example" }, { "name": "vpc", "type": "string", "optional": false, "description": "Identifier of the VPC.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects.Vpcs_get" ] }, "GET /api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets": { "verb": "GET", "path": "/api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets", "query_fields": [ { "name": "ids", "type": "array", "optional": true, "description": "Identifiers that subnet must have to match the filter (see *Vcenter.Network.Projects.Vpcs.Subnets.SubnetInfo.id*).", "enum": [], "example": [ "example" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that subnet must have to match the filter (see *Vcenter.Network.Projects.Vpcs.Subnets.SubnetInfo.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "external_ids", "type": "array", "optional": true, "description": "External identifiers that subnet must have to match the filter (see *Vcenter.Network.Projects.Vpcs.Subnets.SubnetInfo.external_id*).", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the project to which the subnet belongs.", "enum": [], "example": "example" }, { "name": "vpc", "type": "string", "optional": false, "description": "Identifier of the VPC to which the subnet belongs.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects.Vpcs.Subnets_list" ] }, "GET /api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets/{subnet}": { "verb": "GET", "path": "/api/vcenter/network/projects/{project}/vpcs/{vpc}/subnets/{subnet}", "query_fields": [], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the project to which the subnet belongs.", "enum": [], "example": "example" }, { "name": "vpc", "type": "string", "optional": false, "description": "Identifier of the VPC to which the subnet belongs.", "enum": [], "example": "example" }, { "name": "subnet", "type": "string", "optional": false, "description": "Identifier of the subnet.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Network.Projects.Vpcs.Subnets_get" ] }, "GET /api/vcenter/ovf/export-flag": { "verb": "GET", "path": "/api/vcenter/ovf/export-flag", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Ovf.ExportFlag_list" ] }, "GET /api/vcenter/ovf/import-flag": { "verb": "GET", "path": "/api/vcenter/ovf/import-flag", "query_fields": [ { "name": "resource_pool", "type": "string", "optional": false, "description": "The identifier of resource pool target for retrieving the import flag(s).", "enum": [], "example": "resgroup-22" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Ovf.ImportFlag_list" ] }, "GET /api/vcenter/phm/about": { "verb": "GET", "path": "/api/vcenter/phm/about", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.About_get" ] }, "GET /api/vcenter/phm/hardware-support-managers": { "verb": "GET", "path": "/api/vcenter/phm/hardware-support-managers", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers_list" ] }, "GET /api/vcenter/phm/hardware-support-managers/{key}": { "verb": "GET", "path": "/api/vcenter/phm/hardware-support-managers/{key}", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "identifier of a hardware support manager", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers_get" ] }, "GET /api/vcenter/phm/hardware-support-managers/{key}/managed-hosts": { "verb": "GET", "path": "/api/vcenter/phm/hardware-support-managers/{key}/managed-hosts", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key of the targeted hardware support manager", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers.ManagedHosts_list" ] }, "GET /api/vcenter/phm/hardware-support-managers/{key}/resource-bundle": { "verb": "GET", "path": "/api/vcenter/phm/hardware-support-managers/{key}/resource-bundle", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key of the targeted hardware support manager", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers.ResourceBundle_get" ] }, "GET /api/vcenter/resource-pool": { "verb": "GET", "path": "/api/vcenter/resource-pool", "query_fields": [ { "name": "resource_pools", "type": "array", "optional": true, "description": "Identifiers of resource pools that can match the filter.", "enum": [], "example": [ "resgroup-22" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that resource pools must have to match the filter (see *Vcenter.ResourcePool.Info.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "parent_resource_pools", "type": "array", "optional": true, "description": "Resource pools that must contain the resource pool for the resource pool to match the filter.", "enum": [], "example": [ "example" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the resource pool for the resource pool to match the filter.", "enum": [], "example": [ "datacenter-21" ] }, { "name": "hosts", "type": "array", "optional": true, "description": "Hosts that must contain the resource pool for the resource pool to match the filter.", "enum": [], "example": [ "host-11" ] }, { "name": "clusters", "type": "array", "optional": true, "description": "Clusters that must contain the resource pool for the resource pool to match the filter.", "enum": [], "example": [ "domain-c21" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ResourcePool_list" ] }, "GET /api/vcenter/resource-pool/{resourcePool}": { "verb": "GET", "path": "/api/vcenter/resource-pool/{resourcePool}", "query_fields": [], "path_fields": [ { "name": "resourcePool", "type": "string", "optional": false, "description": "Identifier of the resource pool for which information should be retrieved.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ResourcePool_get" ] }, "GET /api/vcenter/services": { "verb": "GET", "path": "/api/vcenter/services", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Services.Service_listDetails" ] }, "GET /api/vcenter/services/{service}": { "verb": "GET", "path": "/api/vcenter/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "identifier of the service whose state is being queried.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Services.Service_get" ] }, "GET /api/vcenter/storage/policies": { "verb": "GET", "path": "/api/vcenter/storage/policies", "query_fields": [ { "name": "policies", "type": "array", "optional": true, "description": "Identifiers of storage policies that can match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Storage.Policies_list" ] }, "GET /api/vcenter/storage/policies/compliance/vm": { "verb": "GET", "path": "/api/vcenter/storage/policies/compliance/vm", "query_fields": [ { "name": "status", "type": "array", "optional": false, "description": "Compliance Status that a virtual machine must have to match the filter. Atleast one status must be specified.", "enum": [], "example": [ "example" ] }, { "name": "vms", "type": "array", "optional": true, "description": "Identifiers of virtual machines that can match the filter", "enum": [], "example": [ "vm-101" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Storage.Policies.Compliance.VM_list" ] }, "GET /api/vcenter/storage/policies/entities/compliance": { "verb": "GET", "path": "/api/vcenter/storage/policies/entities/compliance", "query_fields": [ { "name": "status", "type": "array", "optional": false, "description": "Compliance Status that a virtual machine must have to match the filter.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Storage.Policies.Compliance_list" ] }, "GET /api/vcenter/storage/policies/{policy}/vm": { "verb": "GET", "path": "/api/vcenter/storage/policies/{policy}/vm", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "storage policy identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Storage.Policies.VM_list" ] }, "GET /api/vcenter/system-config/deployment-type": { "verb": "GET", "path": "/api/vcenter/system-config/deployment-type", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.SystemConfig.DeploymentType_get" ] }, "GET /api/vcenter/system-config/psc-registration": { "verb": "GET", "path": "/api/vcenter/system-config/psc-registration", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.SystemConfig.PscRegistration_get" ] }, "GET /api/vcenter/tagging/associations": { "verb": "GET", "path": "/api/vcenter/tagging/associations", "query_fields": [ { "name": "iterate", "type": "object", "optional": true, "description": "The specification of a page to be retrieved.", "enum": [], "example": { "marker": "example" } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Tagging.Associations_list" ] }, "GET /api/vcenter/tagging/categories": { "verb": "GET", "path": "/api/vcenter/tagging/categories", "query_fields": [ { "name": "names", "type": "array", "optional": true, "description": "Categories need to have a name equal to one of the strings in this set to match the filter.", "enum": [], "example": [ "web-01" ] }, { "name": "iterate", "type": "object", "optional": true, "description": "The specification of a page to be retrieved.", "enum": [], "example": { "marker": "example", "page_size": 1 } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Tagging.Categories_list" ] }, "GET /api/vcenter/tagging/tags": { "verb": "GET", "path": "/api/vcenter/tagging/tags", "query_fields": [ { "name": "names", "type": "array", "optional": true, "description": "Tags need to have a name equal to one of the strings in this set to match the filter.", "enum": [], "example": [ "web-01" ] }, { "name": "iterate", "type": "object", "optional": true, "description": "The specification of a page to be retrieved.", "enum": [], "example": { "marker": "example", "page_size": 1 } } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Tagging.Tags_list" ] }, "GET /api/vcenter/topology/nodes": { "verb": "GET", "path": "/api/vcenter/topology/nodes", "query_fields": [ { "name": "types", "type": "array", "optional": true, "description": "Types of the appliance that a vCenter and Platform Services Controller node must be to match the filter (see *Vcenter.Topology.Nodes.ApplianceType*.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Topology.Nodes_list" ] }, "GET /api/vcenter/topology/nodes/{node}": { "verb": "GET", "path": "/api/vcenter/topology/nodes/{node}", "query_fields": [], "path_fields": [ { "name": "node", "type": "string", "optional": false, "description": "Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Topology.Nodes_get" ] }, "GET /api/vcenter/topology/replication-status": { "verb": "GET", "path": "/api/vcenter/topology/replication-status", "query_fields": [ { "name": "nodes", "type": "array", "optional": true, "description": "Identifier that a vCenter and Platform Services Controller node must have to match the filter. (see *Vcenter.Topology.ReplicationStatus.Summary.node*).", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Topology.ReplicationStatus_list" ] }, "GET /api/vcenter/trusted-infrastructure/attestation/services/{service}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/attestation/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "the Attestation Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Attestation.Services_get" ] }, "GET /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm", "query_fields": [ { "name": "filter", "type": "object", "optional": true, "description": "a filter for the returned list.", "enum": [], "example": { "active": false } }, { "name": "major_versions", "type": "array", "optional": true, "description": "The TPM major version number.", "enum": [], "example": [ 1 ] } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm_list" ] }, "GET /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "tpm", "type": "string", "optional": false, "description": "the TPM identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm_get" ] }, "GET /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys", "query_fields": [ { "name": "types", "type": "array", "optional": true, "description": "Type of the endorsement key.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "tpm", "type": "string", "optional": false, "description": "the TPM identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm.EndorsementKeys_list" ] }, "GET /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys/{key}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys/{key}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "tpm", "type": "string", "optional": false, "description": "the TPM identifier.", "enum": [], "example": "example" }, { "name": "key", "type": "string", "optional": false, "description": "the endorsement key identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm.EndorsementKeys_get" ] }, "GET /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/event-log": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/event-log", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "tpm", "type": "string", "optional": false, "description": "the TPM identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm.EventLog_get" ] }, "GET /api/vcenter/trusted-infrastructure/kms/services/{service}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/kms/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "the Key Provider Service instance unique identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Kms.Services_get" ] }, "GET /api/vcenter/trusted-infrastructure/principal": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/principal", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Principal_get" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters", "query_fields": [ { "name": "cluster", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": "domain-c21" }, { "name": "state", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters_list" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Cluster id.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters_get" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images", "query_fields": [ { "name": "version", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": [ "example" ] }, { "name": "display_name", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": [ "example" ] }, { "name": "health", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Os.Esx.BaseImages_list$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images/{version}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "version", "type": "string", "optional": false, "description": "The ESX base image version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Os.Esx.BaseImages_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/service-status": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/service-status", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.ServiceStatus_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.CaCertificates_list$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates/{name}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "name", "type": "string", "optional": false, "description": "The CA certificate name.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.CaCertificates_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.EndorsementKeys_list$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys/{name}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" }, { "name": "name", "type": "string", "optional": false, "description": "The endorsement key name.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.EndorsementKeys_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.Settings_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals/{profile}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the Trust Authority Cluster on which the profile is configured.", "enum": [], "example": "domain-c21" }, { "name": "profile", "type": "string", "optional": false, "description": "The ID of the profile.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.ConsumerPrincipals_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers_list$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.ClientCertificate_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.ClientCertificate.Csr_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/current": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/current", "query_fields": [ { "name": "spec", "type": "object", "optional": true, "description": "Filter spec.", "enum": [], "example": { "trusted": false } }, { "name": "server_names", "type": "array", "optional": true, "description": "This property is deprecated as of __vSphere API 8.0.3.0__ and removed in __vSphere API 9.0.0.0__.", "enum": [], "example": [ "example" ] } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.CurrentPeerCertificates_list$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.TrustedPeerCertificates_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/service-status": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/service-status", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.ServiceStatus_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/attestation/": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/attestation/", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "*Vcenter.Host* id.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityHosts.Attestation_get" ] }, "GET /api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms/", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "*Vcenter.Host* id.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityHosts.Kms_get" ] }, "GET /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config", "query_fields": [ { "name": "address", "type": "object", "optional": false, "description": "The network address of the Attestation Service instance.", "enum": [], "example": { "hostname": "example" } } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.ServicesAppliedConfig_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services/{service}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "service", "type": "string", "optional": false, "description": "The ID of the service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.Services_get" ] }, "GET /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config", "query_fields": [ { "name": "address", "type": "object", "optional": false, "description": "The network address of the Key Provider service instance.", "enum": [], "example": { "hostname": "example" } } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.ServicesAppliedConfig_get$Task" ] }, "GET /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services/{service}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "service", "type": "string", "optional": false, "description": "The ID of the service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.Services_get" ] }, "GET /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config": { "verb": "GET", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.ServicesAppliedConfig_get$Task" ] }, "GET /api/vcenter/utilization/connections": { "verb": "GET", "path": "/api/vcenter/utilization/connections", "query_fields": [ { "name": "services", "type": "array", "optional": true, "description": "List of services to be included in the result.", "enum": [], "example": [ "example" ] }, { "name": "ports", "type": "array", "optional": true, "description": "List of port numbers to be included in the result.", "enum": [], "example": [ 1 ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Utilization.Connections_list" ] }, "GET /api/vcenter/utilization/proxies": { "verb": "GET", "path": "/api/vcenter/utilization/proxies", "query_fields": [ { "name": "services", "type": "array", "optional": true, "description": "List of services to be included in the final result.", "enum": [], "example": [ "example" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Utilization.Proxies_list" ] }, "GET /api/vcenter/vcha/cluster/deployment-type": { "verb": "GET", "path": "/api/vcenter/vcha/cluster/deployment-type", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster.DeploymentType_get" ] }, "GET /api/vcenter/vcha/cluster/mode": { "verb": "GET", "path": "/api/vcenter/vcha/cluster/mode", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster.Mode_get" ] }, "GET /api/vcenter/vcha/operations": { "verb": "GET", "path": "/api/vcenter/vcha/operations", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Operations_get" ] }, "GET /api/vcenter/vm": { "verb": "GET", "path": "/api/vcenter/vm", "query_fields": [ { "name": "vms", "type": "array", "optional": true, "description": "Identifiers of virtual machines that can match the filter.", "enum": [], "example": [ "vm-101" ] }, { "name": "names", "type": "array", "optional": true, "description": "Names that virtual machines must have to match the filter (see *Vcenter.VM.Info.name*).", "enum": [], "example": [ "web-01" ] }, { "name": "folders", "type": "array", "optional": true, "description": "Folders that must contain the virtual machine for the virtual machine to match the filter.", "enum": [], "example": [ "group-v23" ] }, { "name": "datacenters", "type": "array", "optional": true, "description": "Datacenters that must contain the virtual machine for the virtual machine to match the filter.", "enum": [], "example": [ "datacenter-21" ] }, { "name": "hosts", "type": "array", "optional": true, "description": "Hosts that must contain the virtual machine for the virtual machine to match the filter.", "enum": [], "example": [ "host-11" ] }, { "name": "clusters", "type": "array", "optional": true, "description": "Clusters that must contain the virtual machine for the virtual machine to match the filter.", "enum": [], "example": [ "domain-c21" ] }, { "name": "resource_pools", "type": "array", "optional": true, "description": "Resource pools that must contain the virtual machine for the virtual machine to match the filter.", "enum": [], "example": [ "resgroup-22" ] }, { "name": "power_states", "type": "array", "optional": true, "description": "Power states that a virtual machine must be in to match the filter (see *Vcenter.Vm.Power.Info.state*.", "enum": [], "example": [ "POWERED_ON" ] } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VM_list" ] }, "GET /api/vcenter/vm-template/library-items/{templateLibraryItem}": { "verb": "GET", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "identifier of the library item containing the virtual machine template.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems_get" ] }, "GET /api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs": { "verb": "GET", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.CheckOuts_list" ] }, "GET /api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}": { "verb": "GET", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" }, { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the checked out virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.CheckOuts_get" ] }, "GET /api/vcenter/vm-template/library-items/{templateLibraryItem}/versions": { "verb": "GET", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.Versions_list" ] }, "GET /api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}": { "verb": "GET", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}", "query_fields": [], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Version of the library item.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.Versions_get" ] }, "GET /api/vcenter/vm/{vm}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VM_get" ] }, "GET /api/vcenter/vm/{vm}/compute/policies/{policy}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/compute/policies/{policy}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine to query the status for.", "enum": [], "example": "vm-101" }, { "name": "policy", "type": "string", "optional": false, "description": "Identifier of the policy to query the status for.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Compute.Policies_get" ] }, "GET /api/vcenter/vm/{vm}/data-sets": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/data-sets", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets_list" ] }, "GET /api/vcenter/vm/{vm}/data-sets/{dataSet}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set to be queried.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets_get" ] }, "GET /api/vcenter/vm/{vm}/data-sets/{dataSet}/entries": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets.Entries_list" ] }, "GET /api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set.", "enum": [], "example": "example" }, { "name": "key", "type": "string", "optional": false, "description": "The key of the entry to retrieve.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets.Entries_get" ] }, "GET /api/vcenter/vm/{vm}/evc-mode": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/evc-mode", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The identifier of the VM.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.EvcMode_get" ] }, "GET /api/vcenter/vm/{vm}/guest/customization": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/customization", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The unique identifier of the virtual machine that needs to be queried.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Customization_get" ] }, "GET /api/vcenter/vm/{vm}/guest/customization-live": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/customization-live", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The unique identifier of the virtual machine that needs to be queried.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.CustomizationLive_get" ] }, "GET /api/vcenter/vm/{vm}/guest/identity": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/identity", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Identity_get" ] }, "GET /api/vcenter/vm/{vm}/guest/local-filesystem": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/local-filesystem", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.LocalFilesystem_get" ] }, "GET /api/vcenter/vm/{vm}/guest/networking": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/networking", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine ID", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Networking_get" ] }, "GET /api/vcenter/vm/{vm}/guest/networking/interfaces": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/networking/interfaces", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine ID", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Networking.Interfaces_list" ] }, "GET /api/vcenter/vm/{vm}/guest/networking/routes": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/networking/routes", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine ID", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Networking.Routes_list" ] }, "GET /api/vcenter/vm/{vm}/guest/operations": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/operations", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Operations_get" ] }, "GET /api/vcenter/vm/{vm}/guest/power": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/guest/power", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Power_get" ] }, "GET /api/vcenter/vm/{vm}/hardware": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/nvme": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/nvme", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Nvme_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual NVMe adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Nvme_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/sata": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/sata", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Sata_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/sata/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual SATA adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Sata_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/scsi": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/scsi", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Scsi_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual SCSI adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Scsi_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/boot": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/boot", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Boot_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/boot/device": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/boot/device", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Boot.Device_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/cdrom": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/cdrom", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "cdrom", "type": "string", "optional": false, "description": "Virtual CD-ROM device identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/cpu": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/cpu", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Cpu_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/disk": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/disk", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Disk_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/disk/{disk}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/disk/{disk}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "disk", "type": "string", "optional": false, "description": "Virtual disk identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Disk_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/ethernet": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/ethernet", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/ethernet/{nic}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/ethernet/{nic}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "nic", "type": "string", "optional": false, "description": "Virtual Ethernet adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/floppy": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/floppy", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/floppy/{floppy}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/floppy/{floppy}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "floppy", "type": "string", "optional": false, "description": "Virtual floppy drive identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/memory": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/memory", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Memory_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/parallel": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/parallel", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/parallel/{port}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/parallel/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual parallel port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_get" ] }, "GET /api/vcenter/vm/{vm}/hardware/serial": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/serial", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_list" ] }, "GET /api/vcenter/vm/{vm}/hardware/serial/{port}": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/hardware/serial/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual serial port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_get" ] }, "GET /api/vcenter/vm/{vm}/library-item": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/library-item", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.LibraryItem_get" ] }, "GET /api/vcenter/vm/{vm}/power": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/power", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Power_get" ] }, "GET /api/vcenter/vm/{vm}/storage/policy": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/storage/policy", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Storage.Policy_get" ] }, "GET /api/vcenter/vm/{vm}/storage/policy/compliance": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/storage/policy/compliance", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Storage.Policy.Compliance_get" ] }, "GET /api/vcenter/vm/{vm}/tools": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/tools", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Tools_get" ] }, "GET /api/vcenter/vm/{vm}/tools/installer": { "verb": "GET", "path": "/api/vcenter/vm/{vm}/tools/installer", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Tools.Installer_get" ] }, "PATCH /api/appliance/health/settings": { "verb": "PATCH", "path": "/api/appliance/health/settings", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "db_health_check_state_manual_backup", "type": "boolean", "description": "db_health_check_state_manual_backup", "optional": true, "enum": [], "example": false }, { "name": "db_health_check_state_scheduled_backup", "type": "boolean", "description": "db_health_check_state_scheduled_backup", "optional": true, "enum": [], "example": false } ], "body_example": { "db_health_check_state_manual_backup": false, "db_health_check_state_scheduled_backup": false }, "operation_ids": [ "Appliance.HealthCheckSettings_update" ] }, "PATCH /api/appliance/local-accounts/{username}": { "verb": "PATCH", "path": "/api/appliance/local-accounts/{username}", "query_fields": [], "path_fields": [ { "name": "username", "type": "string", "optional": false, "description": "User login name", "enum": [], "example": "example" } ], "body_fields": [ { "name": "password", "type": "string", "description": "password", "optional": true, "enum": [], "example": "example" }, { "name": "old_password", "type": "string", "description": "old_password", "optional": true, "enum": [], "example": "example" }, { "name": "full_name", "type": "string", "description": "full_name", "optional": true, "enum": [], "example": "example" }, { "name": "email", "type": "string", "description": "email", "optional": true, "enum": [], "example": "example" }, { "name": "roles.0", "type": "string", "description": "roles.0", "optional": true, "enum": [], "example": "example" }, { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "password": "example", "old_password": "example", "full_name": "example", "email": "example", "roles": [ "example" ], "enabled": false }, "operation_ids": [ "Appliance.LocalAccounts_update" ] }, "PATCH /api/appliance/networking": { "verb": "PATCH", "path": "/api/appliance/networking", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "ipv6_enabled", "type": "boolean", "description": "ipv6_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "ipv6_enabled": false }, "operation_ids": [ "Appliance.Networking_update" ] }, "PATCH /api/appliance/recovery/backup/schedules/{schedule}": { "verb": "PATCH", "path": "/api/appliance/recovery/backup/schedules/{schedule}", "query_fields": [], "path_fields": [ { "name": "schedule", "type": "string", "optional": false, "description": "Identifier of the schedule", "enum": [], "example": "example" } ], "body_fields": [ { "name": "parts.0", "type": "string", "description": "parts.0", "optional": true, "enum": [], "example": "example" }, { "name": "backup_password", "type": "string", "description": "backup_password", "optional": true, "enum": [], "example": "example" }, { "name": "location", "type": "string", "description": "location", "optional": true, "enum": [], "example": "example" }, { "name": "location_user", "type": "string", "description": "location_user", "optional": true, "enum": [], "example": "example" }, { "name": "location_password", "type": "string", "description": "location_password", "optional": true, "enum": [], "example": "example" }, { "name": "enable", "type": "boolean", "description": "enable", "optional": true, "enum": [], "example": false } ], "body_example": { "parts": [ "example" ], "backup_password": "example", "location": "example", "location_user": "example", "location_password": "example", "enable": false }, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_update" ] }, "PATCH /api/cis/tagging/category/{categoryId}": { "verb": "PATCH", "path": "/api/cis/tagging/category/{categoryId}", "query_fields": [], "path_fields": [ { "name": "categoryId", "type": "string", "optional": false, "description": "The identifier of the category to be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Cis.Tagging.Category_update" ] }, "PATCH /api/cis/tagging/tag/{tagId}": { "verb": "PATCH", "path": "/api/cis/tagging/tag/{tagId}", "query_fields": [], "path_fields": [ { "name": "tagId", "type": "string", "optional": false, "description": "The identifier of the input tag.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Cis.Tagging.Tag_update" ] }, "PATCH /api/content/configuration": { "verb": "PATCH", "path": "/api/content/configuration", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "automatic_sync_enabled", "type": "boolean", "description": "automatic_sync_enabled", "optional": true, "enum": [], "example": false }, { "name": "automatic_sync_enabled_setting.reboot_required", "type": "boolean", "description": "automatic_sync_enabled_setting.reboot_required", "optional": true, "enum": [], "example": false }, { "name": "automatic_sync_enabled_setting.name", "type": "string", "description": "automatic_sync_enabled_setting.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "automatic_sync_start_hour", "type": "integer", "description": "automatic_sync_start_hour", "optional": true, "enum": [], "example": 1 }, { "name": "automatic_sync_start_hour_setting.reboot_required", "type": "boolean", "description": "automatic_sync_start_hour_setting.reboot_required", "optional": true, "enum": [], "example": false }, { "name": "automatic_sync_start_hour_setting.name", "type": "string", "description": "automatic_sync_start_hour_setting.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "automatic_sync_stop_hour", "type": "integer", "description": "automatic_sync_stop_hour", "optional": true, "enum": [], "example": 1 }, { "name": "automatic_sync_stop_hour_setting.reboot_required", "type": "boolean", "description": "automatic_sync_stop_hour_setting.reboot_required", "optional": true, "enum": [], "example": false }, { "name": "automatic_sync_stop_hour_setting.name", "type": "string", "description": "automatic_sync_stop_hour_setting.name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "automatic_sync_enabled": false, "automatic_sync_enabled_setting": { "constraints": [ {} ], "reboot_required": false, "name": "web-01" }, "automatic_sync_start_hour": 1, "automatic_sync_start_hour_setting": { "constraints": [ {} ], "reboot_required": false, "name": "web-01" }, "automatic_sync_stop_hour": 1, "automatic_sync_stop_hour_setting": { "constraints": [ {} ], "reboot_required": false, "name": "web-01" } }, "operation_ids": [ "Content.Configuration_update" ] }, "PATCH /api/content/library/item/update-session/{updateSessionId}": { "verb": "PATCH", "path": "/api/content/library/item/update-session/{updateSessionId}", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifer of the update session that should be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "id", "type": "string", "description": "id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_id", "type": "string", "description": "library_item_id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_content_version", "type": "string", "description": "library_item_content_version", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.args.0", "type": "string", "description": "error_message.args.0", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.id", "type": "string", "description": "error_message.id", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.default_message", "type": "string", "description": "error_message.default_message", "optional": true, "enum": [], "example": "example" }, { "name": "client_progress", "type": "integer", "description": "client_progress", "optional": true, "enum": [], "example": 1 }, { "name": "state", "type": "string", "description": "state", "optional": true, "enum": [], "example": "example" } ], "body_example": { "id": "example", "library_item_id": "example", "library_item_content_version": "example", "error_message": { "args": [ "example" ], "id": "example", "default_message": "example" }, "client_progress": 1, "state": "example" }, "operation_ids": [ "Content.Library.Item.UpdateSession_update" ] }, "PATCH /api/content/library/item/{libraryItemId}": { "verb": "PATCH", "path": "/api/content/library/item/{libraryItemId}", "query_fields": [], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item to update.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.Library.Item_update" ] }, "PATCH /api/content/library/{libraryId}": { "verb": "PATCH", "path": "/api/content/library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the library to update.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.Library_update" ] }, "PATCH /api/content/library/{library}/subscriptions/{subscription}": { "verb": "PATCH", "path": "/api/content/library/{library}/subscriptions/{subscription}", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier of the published library.", "enum": [], "example": "example" }, { "name": "subscription", "type": "string", "optional": false, "description": "subscription identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "subscribed_library_vcenter.hostname", "type": "string", "description": "subscribed_library_vcenter.hostname", "optional": true, "enum": [], "example": "example" }, { "name": "subscribed_library_vcenter.https_port", "type": "integer", "description": "subscribed_library_vcenter.https_port", "optional": true, "enum": [], "example": 1 }, { "name": "subscribed_library_placement.folder", "type": "string", "description": "subscribed_library_placement.folder", "optional": true, "enum": [], "example": "group-v23" }, { "name": "subscribed_library_placement.cluster", "type": "string", "description": "subscribed_library_placement.cluster", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "subscribed_library_placement.resource_pool", "type": "string", "description": "subscribed_library_placement.resource_pool", "optional": true, "enum": [], "example": "resgroup-22" }, { "name": "subscribed_library_placement.host", "type": "string", "description": "subscribed_library_placement.host", "optional": true, "enum": [], "example": "host-11" }, { "name": "subscribed_library_placement.network", "type": "string", "description": "subscribed_library_placement.network", "optional": true, "enum": [], "example": "network-41" } ], "body_example": { "subscribed_library_vcenter": { "hostname": "example", "https_port": 1 }, "subscribed_library_placement": { "folder": "group-v23", "cluster": "domain-c21", "resource_pool": "resgroup-22", "host": "host-11", "network": "network-41" } }, "operation_ids": [ "Content.Library.Subscriptions_update" ] }, "PATCH /api/content/local-library/{libraryId}": { "verb": "PATCH", "path": "/api/content/local-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the local library to update.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.LocalLibrary_update" ] }, "PATCH /api/content/subscribed-library/{libraryId}": { "verb": "PATCH", "path": "/api/content/subscribed-library/{libraryId}", "query_fields": [], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the subscribed library to update.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.SubscribedLibrary_update" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "components_to_delete.0", "type": "string", "description": "components_to_delete.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "components_to_set": {}, "components_to_delete": [ "example" ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.Components_update" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "components_to_delete.0", "type": "string", "description": "components_to_delete.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "components_to_set": {}, "components_to_delete": [ "example" ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.Components_update" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/pci-device-overrides/vcg-entries": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/pci-device-overrides/vcg-entries", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "identifier of the cluster for validity domain of this update", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": { "product_selections": [ { "target": {} } ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.PciDeviceOverrides.VcgEntries_update$Task" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/compliance-status": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/compliance-status", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": { "device_reclassifications": [ { "key": {} } ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.StorageDeviceOverrides.ComplianceStatus_update$Task" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/vcg-entries": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility/storage-device-overrides/vcg-entries", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": { "product_selections": [ { "key": {} } ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility.StorageDeviceOverrides.VcgEntries_update$Task" ] }, "PATCH /api/esx/settings/clusters/{cluster}/software/solutions": { "verb": "PATCH", "path": "/api/esx/settings/clusters/{cluster}/software/solutions", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": { "solutions": {} }, "operation_ids": [ "Esx.Settings.Clusters.Software.Solutions_update$Task" ] }, "PATCH /api/esx/settings/depots/online/{depot}": { "verb": "PATCH", "path": "/api/esx/settings/depots/online/{depot}", "query_fields": [], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier of the depot to be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Esx.Settings.Depots.Online_update" ] }, "PATCH /api/esx/settings/depots/umds": { "verb": "PATCH", "path": "/api/esx/settings/depots/umds", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Esx.Settings.Depots.Umds_update" ] }, "PATCH /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components": { "verb": "PATCH", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "components_to_delete.0", "type": "string", "description": "components_to_delete.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "components_to_set": {}, "components_to_delete": [ "example" ] }, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.Components_update" ] }, "PATCH /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components": { "verb": "PATCH", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "components_to_delete.0", "type": "string", "description": "components_to_delete.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "components_to_set": {}, "components_to_delete": [ "example" ] }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.Components_update" ] }, "PATCH /api/esx/settings/repository/software/drafts/{draft}/components": { "verb": "PATCH", "path": "/api/esx/settings/repository/software/drafts/{draft}/components", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "components_to_delete.0", "type": "string", "description": "components_to_delete.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "components_to_set": {}, "components_to_delete": [ "example" ] }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.Components_update" ] }, "PATCH /api/esx/settings/repository/software/{softwareSpec}": { "verb": "PATCH", "path": "/api/esx/settings/repository/software/{softwareSpec}", "query_fields": [], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "Identifier of the software specification in the repository.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" }, { "name": "orchestrator.owner", "type": "string", "description": "orchestrator.owner", "optional": true, "enum": [], "example": "example" }, { "name": "orchestrator.owner_data", "type": "string", "description": "orchestrator.owner_data", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example", "orchestrator": { "owner": "example", "owner_data": "example" } }, "operation_ids": [ "Esx.Settings.Repository.Software_update" ] }, "PATCH /api/stats/acq-specs/{id}": { "verb": "PATCH", "path": "/api/stats/acq-specs/{id}", "query_fields": [], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "Acquisition specification ID.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "counters.cid_mid.cid", "type": "string", "description": "counters.cid_mid.cid", "optional": true, "enum": [], "example": "example" }, { "name": "counters.set_id", "type": "string", "description": "counters.set_id", "optional": true, "enum": [], "example": "example" }, { "name": "resources.0.id_value", "type": "string", "description": "resources.0.id_value", "optional": true, "enum": [], "example": "example" }, { "name": "interval", "type": "integer", "description": "interval", "optional": true, "enum": [], "example": 1 }, { "name": "expiration", "type": "integer", "description": "expiration", "optional": true, "enum": [], "example": 1 }, { "name": "memo_", "type": "string", "description": "memo_", "optional": true, "enum": [], "example": "example" } ], "body_example": { "counters": { "cid_mid": { "cid": "example" }, "set_id": "example" }, "resources": [ { "id_value": "example" } ], "interval": 1, "expiration": 1, "memo_": "example" }, "operation_ids": [ "Vstats.AcqSpecs_update" ] }, "PATCH /api/vcenter/authorization/permissions/{permission}": { "verb": "PATCH", "path": "/api/vcenter/authorization/permissions/{permission}", "query_fields": [], "path_fields": [ { "name": "permission", "type": "string", "optional": false, "description": "the unique identifier of the permission which is about to be updated in the vCenter Server.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "role", "type": "string", "description": "role", "optional": true, "enum": [], "example": "example" }, { "name": "is_propagating", "type": "boolean", "description": "is_propagating", "optional": true, "enum": [], "example": false } ], "body_example": { "role": "example", "is_propagating": false }, "operation_ids": [ "Vcenter.Authorization.Permissions_update" ] }, "PATCH /api/vcenter/authorization/roles/{role}": { "verb": "PATCH", "path": "/api/vcenter/authorization/roles/{role}", "query_fields": [], "path_fields": [ { "name": "role", "type": "string", "optional": false, "description": "the unique identifier of the role which is about to be updated in the vCenter Server.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Vcenter.Authorization.Roles_update" ] }, "PATCH /api/vcenter/compute/policies/{policy}": { "verb": "PATCH", "path": "/api/vcenter/compute/policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier of the policy to be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.Compute.Policies_update" ] }, "PATCH /api/vcenter/crypto-manager/kms/providers/{provider}": { "verb": "PATCH", "path": "/api/vcenter/crypto-manager/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "native_spec.key_id", "type": "string", "description": "native_spec.key_id", "optional": true, "enum": [], "example": "example" } ], "body_example": { "native_spec": { "key_id": "example" } }, "operation_ids": [ "Vcenter.CryptoManager.Kms.Providers_update" ] }, "PATCH /api/vcenter/deployment/size": { "verb": "PATCH", "path": "/api/vcenter/deployment/size", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "deployment_size", "type": "string", "description": "deployment_size", "optional": true, "enum": [], "example": "example" }, { "name": "connection.password", "type": "string", "description": "connection.password", "optional": true, "enum": [], "example": "example" }, { "name": "connection.username", "type": "string", "description": "connection.username", "optional": true, "enum": [], "example": "example" }, { "name": "connection.hostname", "type": "string", "description": "connection.hostname", "optional": true, "enum": [], "example": "example" } ], "body_example": { "deployment_size": "example", "connection": { "password": "example", "username": "example", "hostname": "example" } }, "operation_ids": [ "Vcenter.Deployment.Size_update" ] }, "PATCH /api/vcenter/identity/providers/{provider}": { "verb": "PATCH", "path": "/api/vcenter/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "provider", "type": "string", "optional": false, "description": "the identifier of the provider to update", "enum": [], "example": "example" } ], "body_fields": [ { "name": "config_tag", "type": "string", "description": "config_tag", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "config_tag": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.Identity.Providers_update" ] }, "PATCH /api/vcenter/lcm/discovery/associated-products/{product}": { "verb": "PATCH", "path": "/api/vcenter/lcm/discovery/associated-products/{product}", "query_fields": [], "path_fields": [ { "name": "product", "type": "string", "optional": false, "description": "An id of the product to be modified.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "deployments.0", "type": "string", "description": "deployments.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "deployments": [ "example" ] }, "operation_ids": [ "Vcenter.Lcm.Discovery.AssociatedProducts_update" ] }, "PATCH /api/vcenter/namespace-management/clusters/{cluster}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces is enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "vsphere_pods_enabled", "type": "boolean", "description": "vsphere_pods_enabled", "optional": true, "enum": [], "example": false }, { "name": "supervisor_services_enabled", "type": "boolean", "description": "supervisor_services_enabled", "optional": true, "enum": [], "example": false }, { "name": "size_hint", "type": "string", "description": "size_hint", "optional": true, "enum": [], "example": "example" }, { "name": "floating_ip", "type": "string", "description": "floating_ip", "optional": true, "enum": [], "example": "example" }, { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" }, { "name": "ncp_cluster_network_spec.default_ingress_tls_certificate", "type": "string", "description": "ncp_cluster_network_spec.default_ingress_tls_certificate", "optional": true, "enum": [], "example": "example" }, { "name": "ncp_cluster_network_spec.default_ingress_tls_private_key", "type": "string", "description": "ncp_cluster_network_spec.default_ingress_tls_private_key", "optional": true, "enum": [], "example": "example" } ], "body_example": { "vsphere_pods_enabled": false, "supervisor_services_enabled": false, "size_hint": "example", "floating_ip": "example", "network_provider": "example", "ncp_cluster_network_spec": { "pod_cidrs": [ {} ], "ingress_cidrs": [ {} ], "egress_cidrs": [ {} ], "default_ingress_tls_certificate": "example", "default_ingress_tls_private_key": "example" } }, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters_update" ] }, "PATCH /api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster the load balancer is associated with.", "enum": [], "example": "domain-c21" }, { "name": "id", "type": "string", "optional": false, "description": "Identifier of the load balancer.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "address_ranges.0.count", "type": "integer", "description": "address_ranges.0.count", "optional": true, "enum": [], "example": 2 }, { "name": "address_ranges.0.address", "type": "string", "description": "address_ranges.0.address", "optional": true, "enum": [], "example": "example" }, { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" }, { "name": "ha_proxy_config_update_spec.username", "type": "string", "description": "ha_proxy_config_update_spec.username", "optional": true, "enum": [], "example": "example" }, { "name": "ha_proxy_config_update_spec.password", "type": "string", "description": "ha_proxy_config_update_spec.password", "optional": true, "enum": [], "example": "example" }, { "name": "ha_proxy_config_update_spec.certificate_authority_chain", "type": "string", "description": "ha_proxy_config_update_spec.certificate_authority_chain", "optional": true, "enum": [], "example": "example" }, { "name": "avi_config_update_spec.username", "type": "string", "description": "avi_config_update_spec.username", "optional": true, "enum": [], "example": "example" }, { "name": "avi_config_update_spec.password", "type": "string", "description": "avi_config_update_spec.password", "optional": true, "enum": [], "example": "example" }, { "name": "avi_config_update_spec.certificate_authority_chain", "type": "string", "description": "avi_config_update_spec.certificate_authority_chain", "optional": true, "enum": [], "example": "example" } ], "body_example": { "address_ranges": [ { "count": 2, "address": "example" } ], "provider": "example", "ha_proxy_config_update_spec": { "username": "example", "password": "example", "certificate_authority_chain": "example" }, "avi_config_update_spec": { "username": "example", "password": "example", "certificate_authority_chain": "example" } }, "operation_ids": [ "Vcenter.NamespaceManagement.LoadBalancers_update" ] }, "PATCH /api/vcenter/namespace-management/clusters/{cluster}/networks/{network}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the vSphere Namespaces network.", "enum": [], "example": "network-41" } ], "body_fields": [ { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" } ], "body_example": { "network_provider": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_update" ] }, "PATCH /api/vcenter/namespace-management/supervisor-services/{supervisorService}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices_update" ] }, "PATCH /api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions/{version}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "activate", "deactivate" ], "example": "activate" } ], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Identifier of the version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.Versions_activate", "Vcenter.NamespaceManagement.SupervisorServices.Versions_deactivate" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/certificates": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/certificates", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "endpoint", "type": "string", "description": "endpoint", "optional": true, "enum": [], "example": "example" }, { "name": "tls_endpoint_certificate", "type": "string", "description": "tls_endpoint_certificate", "optional": true, "enum": [], "example": "example" } ], "body_example": { "endpoint": "example", "tls_endpoint_certificate": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Certificates_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/certificates/key-sizes": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/certificates/key-sizes", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "internal_certs_key_size", "type": "string", "description": "internal_certs_key_size", "optional": true, "enum": [], "example": "example" } ], "body_example": { "internal_certs_key_size": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Certificates.KeySizes_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries/{containerImageRegistry}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which the container image registry is created.", "enum": [], "example": "example" }, { "name": "containerImageRegistry", "type": "string", "optional": false, "description": "Identifier for the container image registry.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ContainerImageRegistries_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/networks/settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/networks/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "backing", "type": "string", "description": "backing", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.port_groups_to_add.0", "type": "string", "description": "network_segments_update_spec.port_groups_to_add.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.port_groups_to_remove.0", "type": "string", "description": "network_segments_update_spec.port_groups_to_remove.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.dns.servers_to_add.0", "type": "string", "description": "network_segments_update_spec.dns.servers_to_add.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.dns.servers_to_remove.0", "type": "string", "description": "network_segments_update_spec.dns.servers_to_remove.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.dns.search_domains_to_add.0", "type": "string", "description": "network_segments_update_spec.dns.search_domains_to_add.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.dns.search_domains_to_remove.0", "type": "string", "description": "network_segments_update_spec.dns.search_domains_to_remove.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.ntp.servers_to_add.0", "type": "string", "description": "network_segments_update_spec.ntp.servers_to_add.0", "optional": true, "enum": [], "example": "example" }, { "name": "network_segments_update_spec.ntp.servers_to_remove.0", "type": "string", "description": "network_segments_update_spec.ntp.servers_to_remove.0", "optional": true, "enum": [], "example": "example" }, { "name": "floating_ip_address", "type": "string", "description": "floating_ip_address", "optional": true, "enum": [], "example": "example" } ], "body_example": { "backing": "example", "network_segments_update_spec": { "port_groups_to_add": [ "example" ], "port_groups_to_remove": [ "example" ], "dns": { "servers_to_add": [ "example" ], "servers_to_remove": [ "example" ], "search_domains_to_add": [ "example" ], "search_domains_to_remove": [ "example" ] }, "ntp": { "servers_to_add": [ "example" ], "servers_to_remove": [ "example" ] } }, "floating_ip_address": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Networks.Settings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "size.identifier", "type": "string", "description": "size.identifier", "optional": true, "enum": [], "example": "example" }, { "name": "login_banner", "type": "string", "description": "login_banner", "optional": true, "enum": [], "example": "example" }, { "name": "count", "type": "integer", "description": "count", "optional": true, "enum": [], "example": 2 } ], "body_example": { "size": { "identifier": "example" }, "login_banner": "example", "count": 2 }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Settings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/storage/policies": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/storage/policies", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "default_policy", "type": "string", "description": "default_policy", "optional": true, "enum": [], "example": "example" } ], "body_example": { "default_policy": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Storage.Policies_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the identifier for the Supervisor associated with the identity provider to be updated.", "enum": [], "example": "example" }, { "name": "provider", "type": "string", "optional": false, "description": "the identifier for the identity provider that is to be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" }, { "name": "issuer_url", "type": "string", "description": "issuer_url", "optional": true, "enum": [], "example": "example" }, { "name": "username_claim", "type": "string", "description": "username_claim", "optional": true, "enum": [], "example": "example" }, { "name": "unset_username_claim", "type": "boolean", "description": "unset_username_claim", "optional": true, "enum": [], "example": false }, { "name": "groups_claim", "type": "string", "description": "groups_claim", "optional": true, "enum": [], "example": "example" }, { "name": "unset_groups_claim", "type": "boolean", "description": "unset_groups_claim", "optional": true, "enum": [], "example": false } ], "body_example": { "display_name": "example", "issuer_url": "example", "username_claim": "example", "unset_username_claim": false, "groups_claim": "example", "unset_groups_claim": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/management-services/{managementService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" }, { "name": "managementService", "type": "string", "optional": false, "description": "Identifier of the Management Service.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ManagementServices_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the remote endpoint is being modified.", "enum": [], "example": "example" }, { "name": "remoteEndpoint", "type": "string", "optional": false, "description": "identifier for the remote endpoint that is being modified.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges/{edge}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges/{edge}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "The unique identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "edge", "type": "string", "optional": false, "description": "The unique identifier for the edge.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" } ], "body_example": { "provider": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks.Edges_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the Supervisor network.", "enum": [], "example": "network-41" } ], "body_fields": [ { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" } ], "body_example": { "network_provider": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-service-settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-service-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "supervisor_services_enabled", "type": "boolean", "description": "supervisor_services_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "supervisor_services_enabled": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServiceSettings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/vsphere-pod-settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/vsphere-pod-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "vsphere_pods_enabled", "type": "boolean", "description": "vsphere_pods_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "vsphere_pods_enabled": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.VspherePodSettings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/images/settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/images/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "registry.hostname", "type": "string", "description": "registry.hostname", "optional": true, "enum": [], "example": "example" }, { "name": "repository", "type": "string", "description": "repository", "optional": true, "enum": [], "example": "example" }, { "name": "content_libraries.0.content_library", "type": "string", "description": "content_libraries.0.content_library", "optional": true, "enum": [], "example": "example" } ], "body_example": { "registry": { "hostname": "example" }, "repository": "example", "content_libraries": [ { "content_library": "example" } ] }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Images.Settings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/kube-api-server-settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/kube-api-server-settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "certificate_dns_names_to_add_list.0", "type": "string", "description": "certificate_dns_names_to_add_list.0", "optional": true, "enum": [], "example": "example" }, { "name": "certificate_dns_names_to_remove_list.0", "type": "string", "description": "certificate_dns_names_to_remove_list.0", "optional": true, "enum": [], "example": "example" }, { "name": "namespace_api_fairness_enabled", "type": "boolean", "description": "namespace_api_fairness_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "certificate_dns_names_to_add_list": [ "example" ], "certificate_dns_names_to_remove_list": [ "example" ], "namespace_api_fairness_enabled": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.KubeApiServerSettings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/networks/settings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/networks/settings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "client_ip_preservation_enabled", "type": "boolean", "description": "client_ip_preservation_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "client_ip_preservation_enabled": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Networks.Settings_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/cloud-native/file-volumes": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/cloud-native/file-volumes", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "file_volumes_enabled", "type": "boolean", "description": "file_volumes_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "file_volumes_enabled": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Storage.CloudNative.FileVolumes_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/policies": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/workloads/storage/policies", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "ephemeral_storage_policy", "type": "string", "description": "ephemeral_storage_policy", "optional": true, "enum": [], "example": "example" }, { "name": "image_storage_policy", "type": "string", "description": "image_storage_policy", "optional": true, "enum": [], "example": "example" } ], "body_example": { "ephemeral_storage_policy": "example", "image_storage_policy": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Workloads.Storage.Policies_update" ] }, "PATCH /api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor", "enum": [], "example": "example" }, { "name": "zone", "type": "string", "optional": false, "description": "The ID of the vSphere Zone.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "resource_allocation": { "vm_reservations": [ {} ] } }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Zones.Bindings_update" ] }, "PATCH /api/vcenter/namespace-management/virtual-machine-classes/{vm_class}": { "verb": "PATCH", "path": "/api/vcenter/namespace-management/virtual-machine-classes/{vm_class}", "query_fields": [], "path_fields": [ { "name": "vm_class", "type": "string", "optional": false, "description": "Identifier for the VM class.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.VirtualMachineClasses_update" ] }, "PATCH /api/vcenter/namespaces/instances/{namespace}": { "verb": "PATCH", "path": "/api/vcenter/namespaces/instances/{namespace}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.Instances_update" ] }, "PATCH /api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}": { "verb": "PATCH", "path": "/api/vcenter/namespaces/namespace-templates/clusters/{cluster}/{template}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" }, { "name": "template", "type": "string", "optional": false, "description": "Name of the namespace template.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "storage_specs.0.policy", "type": "string", "description": "storage_specs.0.policy", "optional": true, "enum": [], "example": "example" }, { "name": "networks.0", "type": "string", "description": "networks.0", "optional": true, "enum": [], "example": "network-41" }, { "name": "permissions.0.subject_type", "type": "string", "description": "permissions.0.subject_type", "optional": true, "enum": [], "example": "example" }, { "name": "permissions.0.domain", "type": "string", "description": "permissions.0.domain", "optional": true, "enum": [], "example": "example" }, { "name": "permissions.0.subject", "type": "string", "description": "permissions.0.subject", "optional": true, "enum": [], "example": "example" }, { "name": "vm_service_spec.content_libraries.0", "type": "string", "description": "vm_service_spec.content_libraries.0", "optional": true, "enum": [], "example": "example" }, { "name": "vm_service_spec.vm_classes.0", "type": "string", "description": "vm_service_spec.vm_classes.0", "optional": true, "enum": [], "example": "example" }, { "name": "content_libraries.0.content_library", "type": "string", "description": "content_libraries.0.content_library", "optional": true, "enum": [], "example": "example" } ], "body_example": { "resource_spec": {}, "storage_specs": [ { "policy": "example" } ], "networks": [ "network-41" ], "permissions": [ { "subject_type": "example", "domain": "example", "subject": "example" } ], "vm_service_spec": { "content_libraries": [ "example" ], "vm_classes": [ "example" ] }, "content_libraries": [ { "content_library": "example" } ] }, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_update" ] }, "PATCH /api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}/{template}": { "verb": "PATCH", "path": "/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}/{template}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "template", "type": "string", "optional": false, "description": "Name of the namespace template.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "storage_specs.0.policy", "type": "string", "description": "storage_specs.0.policy", "optional": true, "enum": [], "example": "example" }, { "name": "networks.0", "type": "string", "description": "networks.0", "optional": true, "enum": [], "example": "network-41" }, { "name": "permissions.0.subject_type", "type": "string", "description": "permissions.0.subject_type", "optional": true, "enum": [], "example": "example" }, { "name": "permissions.0.domain", "type": "string", "description": "permissions.0.domain", "optional": true, "enum": [], "example": "example" }, { "name": "permissions.0.subject", "type": "string", "description": "permissions.0.subject", "optional": true, "enum": [], "example": "example" }, { "name": "vm_service_spec.content_libraries.0", "type": "string", "description": "vm_service_spec.content_libraries.0", "optional": true, "enum": [], "example": "example" }, { "name": "vm_service_spec.vm_classes.0", "type": "string", "description": "vm_service_spec.vm_classes.0", "optional": true, "enum": [], "example": "example" }, { "name": "content_libraries.0.content_library", "type": "string", "description": "content_libraries.0.content_library", "optional": true, "enum": [], "example": "example" } ], "body_example": { "resource_spec": {}, "storage_specs": [ { "policy": "example" } ], "networks": [ "network-41" ], "permissions": [ { "subject_type": "example", "domain": "example", "subject": "example" } ], "vm_service_spec": { "content_libraries": [ "example" ], "vm_classes": [ "example" ] }, "content_libraries": [ { "content_library": "example" } ] }, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_updateV2" ] }, "PATCH /api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}": { "verb": "PATCH", "path": "/api/vcenter/namespaces/{namespace}/management-services/access-grants/{accessGrant}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier of the namespace.", "enum": [], "example": "example" }, { "name": "accessGrant", "type": "string", "optional": false, "description": "Identifier of the Access Grant.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.ManagementServices.AccessGrants_update" ] }, "PATCH /api/vcenter/phm/hardware-support-managers/{key}/managed-hosts": { "verb": "PATCH", "path": "/api/vcenter/phm/hardware-support-managers/{key}/managed-hosts", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key of the targeted hardware support manager", "enum": [], "example": "example" } ], "body_fields": [ { "name": "hosts_to_add.0", "type": "string", "description": "hosts_to_add.0", "optional": true, "enum": [], "example": "example" }, { "name": "hosts_to_remove.0", "type": "string", "description": "hosts_to_remove.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "hosts_to_add": [ "example" ], "hosts_to_remove": [ "example" ] }, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers.ManagedHosts_update" ] }, "PATCH /api/vcenter/phm/hardware-support-managers/{key}/resource-bundle": { "verb": "PATCH", "path": "/api/vcenter/phm/hardware-support-managers/{key}/resource-bundle", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key of the targeted hardware support manager", "enum": [], "example": "example" } ], "body_fields": [ { "name": "bundle_to_change.0.locale", "type": "string", "description": "bundle_to_change.0.locale", "optional": true, "enum": [], "example": "example" } ], "body_example": { "bundle_to_change": [ { "locale": "example", "messages": {} } ] }, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers.ResourceBundle_update" ] }, "PATCH /api/vcenter/resource-pool/{resourcePool}": { "verb": "PATCH", "path": "/api/vcenter/resource-pool/{resourcePool}", "query_fields": [], "path_fields": [ { "name": "resourcePool", "type": "string", "optional": false, "description": "Identifier of the resource pool.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.ResourcePool_update" ] }, "PATCH /api/vcenter/services/{service}": { "verb": "PATCH", "path": "/api/vcenter/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "identifier of the service whose properties are being updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "startup_type", "type": "string", "description": "startup_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "startup_type": "example" }, "operation_ids": [ "Vcenter.Services.Service_update" ] }, "PATCH /api/vcenter/tagging/associations": { "verb": "PATCH", "path": "/api/vcenter/tagging/associations", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "object.type", "type": "string", "description": "object.type", "optional": true, "enum": [], "example": "example" }, { "name": "object.id", "type": "string", "description": "object.id", "optional": true, "enum": [], "example": "example" }, { "name": "tag_spec_list.0.operation", "type": "string", "description": "tag_spec_list.0.operation", "optional": true, "enum": [], "example": "example" } ], "body_example": { "object": { "type": "example", "id": "example" }, "tag_spec_list": [ { "operation": "example" } ] }, "operation_ids": [ "Vcenter.Tagging.Associations_update" ] }, "PATCH /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Cluster id.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "state", "type": "string", "description": "state", "optional": true, "enum": [], "example": "example" } ], "body_example": { "state": "example" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/settings", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "require_endorsement_keys", "type": "boolean", "description": "require_endorsement_keys", "optional": true, "enum": [], "example": false }, { "name": "require_certificate_validation", "type": "boolean", "description": "require_certificate_validation", "optional": true, "enum": [], "example": false } ], "body_example": { "require_endorsement_keys": false, "require_certificate_validation": false }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.Settings_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "master_key_id", "type": "string", "description": "master_key_id", "optional": true, "enum": [], "example": "example" }, { "name": "key_server.description", "type": "string", "description": "key_server.description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "master_key_id": "example", "key_server": { "description": "example" } }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "certificate", "type": "string", "description": "certificate", "optional": true, "enum": [], "example": "example" } ], "body_example": { "certificate": "example" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.ClientCertificate_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/peer-certs/trusted", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "certificates.0", "type": "string", "description": "certificates.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "certificates": [ "example" ] }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.TrustedPeerCertificates_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the Trusted Cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.ServicesAppliedConfig_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the Trusted Cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.ServicesAppliedConfig_update$Task" ] }, "PATCH /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config": { "verb": "PATCH", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/services-applied-config", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.ServicesAppliedConfig_update$Task" ] }, "PATCH /api/vcenter/vm/{vm}/data-sets/{dataSet}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set to be queried.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.Vm.DataSets_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "upgrade_policy", "type": "string", "description": "upgrade_policy", "optional": true, "enum": [], "example": "example" }, { "name": "upgrade_version", "type": "string", "description": "upgrade_version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "upgrade_policy": "example", "upgrade_version": "example" }, "operation_ids": [ "Vcenter.Vm.Hardware_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "adapter", "type": "string", "optional": false, "description": "Virtual SCSI adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "sharing", "type": "string", "description": "sharing", "optional": true, "enum": [], "example": "example" } ], "body_example": { "sharing": "example" }, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Scsi_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/boot": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/boot", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "efi_legacy_boot", "type": "boolean", "description": "efi_legacy_boot", "optional": true, "enum": [], "example": false }, { "name": "network_protocol", "type": "string", "description": "network_protocol", "optional": true, "enum": [], "example": "example" }, { "name": "delay", "type": "integer", "description": "delay", "optional": true, "enum": [], "example": 1 }, { "name": "retry", "type": "boolean", "description": "retry", "optional": true, "enum": [], "example": false }, { "name": "retry_delay", "type": "integer", "description": "retry_delay", "optional": true, "enum": [], "example": 1 } ], "body_example": { "type": "example", "efi_legacy_boot": false, "network_protocol": "example", "delay": 1, "retry": false, "retry_delay": 1 }, "operation_ids": [ "Vcenter.Vm.Hardware.Boot_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "cdrom", "type": "string", "optional": false, "description": "Virtual CD-ROM device identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/cpu": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/cpu", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "count", "type": "integer", "description": "count", "optional": true, "enum": [], "example": 2 }, { "name": "cores_per_socket", "type": "integer", "description": "cores_per_socket", "optional": true, "enum": [], "example": 1 }, { "name": "hot_add_enabled", "type": "boolean", "description": "hot_add_enabled", "optional": true, "enum": [], "example": false }, { "name": "hot_remove_enabled", "type": "boolean", "description": "hot_remove_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "count": 2, "cores_per_socket": 1, "hot_add_enabled": false, "hot_remove_enabled": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Cpu_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/disk/{disk}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/disk/{disk}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "disk", "type": "string", "optional": false, "description": "Virtual disk identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "backing": { "type": "example" } }, "operation_ids": [ "Vcenter.Vm.Hardware.Disk_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/ethernet/{nic}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/ethernet/{nic}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "nic", "type": "string", "optional": false, "description": "Virtual Ethernet adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "upt_compatibility_enabled", "type": "boolean", "description": "upt_compatibility_enabled", "optional": true, "enum": [], "example": false }, { "name": "upt_v2_compatibility_enabled", "type": "boolean", "description": "upt_v2_compatibility_enabled", "optional": true, "enum": [], "example": false }, { "name": "mac_type", "type": "string", "description": "mac_type", "optional": true, "enum": [], "example": "example" }, { "name": "mac_address", "type": "string", "description": "mac_address", "optional": true, "enum": [], "example": "example" }, { "name": "wake_on_lan_enabled", "type": "boolean", "description": "wake_on_lan_enabled", "optional": true, "enum": [], "example": false }, { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "upt_compatibility_enabled": false, "upt_v2_compatibility_enabled": false, "mac_type": "example", "mac_address": "example", "wake_on_lan_enabled": false, "backing": { "type": "example" } }, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/floppy/{floppy}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/floppy/{floppy}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "floppy", "type": "string", "optional": false, "description": "Virtual floppy drive identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/memory": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/memory", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "size_mib", "type": "integer", "description": "size_mib", "optional": true, "enum": [], "example": 2048 }, { "name": "hot_add_enabled", "type": "boolean", "description": "hot_add_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "size_mib": 2048, "hot_add_enabled": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Memory_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/parallel/{port}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/parallel/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual parallel port identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_update" ] }, "PATCH /api/vcenter/vm/{vm}/hardware/serial/{port}": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/hardware/serial/{port}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual serial port identifier.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "yield_on_poll", "type": "boolean", "description": "yield_on_poll", "optional": true, "enum": [], "example": false }, { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "yield_on_poll": false, "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_update" ] }, "PATCH /api/vcenter/vm/{vm}/storage/policy": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/storage/policy", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "vm_home.type", "type": "string", "description": "vm_home.type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "vm_home": { "type": "example" }, "disks": {} }, "operation_ids": [ "Vcenter.Vm.Storage.Policy_update" ] }, "PATCH /api/vcenter/vm/{vm}/tools": { "verb": "PATCH", "path": "/api/vcenter/vm/{vm}/tools", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "upgrade_policy", "type": "string", "description": "upgrade_policy", "optional": true, "enum": [], "example": "example" } ], "body_example": { "upgrade_policy": "example" }, "operation_ids": [ "Vcenter.Vm.Tools_update" ] }, "POST /api/appliance/infraprofile/configs": { "verb": "POST", "path": "/api/appliance/infraprofile/configs", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "export", "import", "validate" ], "example": "export" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Infraprofile.Configs_export", "Appliance.Infraprofile.Configs_importProfile$Task", "Appliance.Infraprofile.Configs_validate$Task" ] }, "POST /api/appliance/local-accounts": { "verb": "POST", "path": "/api/appliance/local-accounts", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "username", "type": "string", "description": "username", "optional": true, "enum": [], "example": "example" }, { "name": "config.password", "type": "string", "description": "config.password", "optional": true, "enum": [], "example": "example" }, { "name": "config.roles.0", "type": "string", "description": "config.roles.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "username": "example", "config": { "password": "example", "roles": [ "example" ] } }, "operation_ids": [ "Appliance.LocalAccounts_create" ] }, "POST /api/appliance/logging/forwarding": { "verb": "POST", "path": "/api/appliance/logging/forwarding", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "test" ], "example": "test" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Logging.Forwarding_test" ] }, "POST /api/appliance/networking": { "verb": "POST", "path": "/api/appliance/networking", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "change", "reset" ], "example": "change" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking_change$Task", "Appliance.Networking_reset" ] }, "POST /api/appliance/networking/dns/domains": { "verb": "POST", "path": "/api/appliance/networking/dns/domains", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "domain", "type": "string", "description": "domain", "optional": true, "enum": [], "example": "example" } ], "body_example": { "domain": "example" }, "operation_ids": [ "Appliance.Networking.Dns.Domains_add" ] }, "POST /api/appliance/networking/dns/hostname": { "verb": "POST", "path": "/api/appliance/networking/dns/hostname", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "test" ], "example": "test" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Dns.Hostname_test" ] }, "POST /api/appliance/networking/dns/servers": { "verb": "POST", "path": "/api/appliance/networking/dns/servers", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "server", "type": "string", "description": "server", "optional": true, "enum": [], "example": "example" } ], "body_example": { "server": "example" }, "operation_ids": [ "Appliance.Networking.Dns.Servers_add" ] }, "POST /api/appliance/networking/proxy/{protocol}": { "verb": "POST", "path": "/api/appliance/networking/proxy/{protocol}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "test" ], "example": "test" } ], "path_fields": [ { "name": "protocol", "type": "string", "optional": false, "description": "Protocol whose proxy is to be tested.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Networking.Proxy_test" ] }, "POST /api/appliance/ntp": { "verb": "POST", "path": "/api/appliance/ntp", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "test" ], "example": "test" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Ntp_test" ] }, "POST /api/appliance/recovery/backup": { "verb": "POST", "path": "/api/appliance/recovery/backup", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "validate" ], "example": "validate" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup_validate" ] }, "POST /api/appliance/recovery/backup/job": { "verb": "POST", "path": "/api/appliance/recovery/backup/job", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "location", "type": "string", "description": "location", "optional": true, "enum": [], "example": "example" }, { "name": "parts.0", "type": "string", "description": "parts.0", "optional": true, "enum": [], "example": "example" }, { "name": "location_type", "type": "string", "description": "location_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "location": "example", "parts": [ "example" ], "location_type": "example" }, "operation_ids": [ "Appliance.Recovery.Backup.Job_create" ] }, "POST /api/appliance/recovery/backup/job/{id}": { "verb": "POST", "path": "/api/appliance/recovery/backup/job/{id}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel" ], "example": "cancel" } ], "path_fields": [ { "name": "id", "type": "string", "optional": false, "description": "ID (ID of job)", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Job_cancel" ] }, "POST /api/appliance/recovery/backup/schedules": { "verb": "POST", "path": "/api/appliance/recovery/backup/schedules", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "schedule", "type": "string", "description": "schedule", "optional": true, "enum": [], "example": "example" }, { "name": "spec.location", "type": "string", "description": "spec.location", "optional": true, "enum": [], "example": "example" } ], "body_example": { "schedule": "example", "spec": { "location": "example" } }, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_create" ] }, "POST /api/appliance/recovery/backup/schedules/{schedule}": { "verb": "POST", "path": "/api/appliance/recovery/backup/schedules/{schedule}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "run" ], "example": "run" } ], "path_fields": [ { "name": "schedule", "type": "string", "optional": false, "description": "Identifier of the schedule", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.Schedules_run" ] }, "POST /api/appliance/recovery/backup/system-name": { "verb": "POST", "path": "/api/appliance/recovery/backup/system-name", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "list" ], "example": "list" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.SystemName_list" ] }, "POST /api/appliance/recovery/backup/system-name/{systemName}/archives": { "verb": "POST", "path": "/api/appliance/recovery/backup/system-name/{systemName}/archives", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "list" ], "example": "list" } ], "path_fields": [ { "name": "systemName", "type": "string", "optional": false, "description": "System name identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.SystemName.Archive_list" ] }, "POST /api/appliance/recovery/backup/system-name/{systemName}/archives/{archive}": { "verb": "POST", "path": "/api/appliance/recovery/backup/system-name/{systemName}/archives/{archive}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get" ], "example": "get" } ], "path_fields": [ { "name": "systemName", "type": "string", "optional": false, "description": "System name identifier.", "enum": [], "example": "example" }, { "name": "archive", "type": "string", "optional": false, "description": "Archive identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Backup.SystemName.Archive_get" ] }, "POST /api/appliance/recovery/reconciliation/job": { "verb": "POST", "path": "/api/appliance/recovery/reconciliation/job", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "sso_admin_user_name", "type": "string", "description": "sso_admin_user_name", "optional": true, "enum": [], "example": "example" }, { "name": "sso_admin_user_password", "type": "string", "description": "sso_admin_user_password", "optional": true, "enum": [], "example": "example" }, { "name": "ignore_warnings", "type": "boolean", "description": "ignore_warnings", "optional": true, "enum": [], "example": false } ], "body_example": { "sso_admin_user_name": "example", "sso_admin_user_password": "example", "ignore_warnings": false }, "operation_ids": [ "Appliance.Recovery.Reconciliation.Job_create" ] }, "POST /api/appliance/recovery/restore": { "verb": "POST", "path": "/api/appliance/recovery/restore", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "validate" ], "example": "validate" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Recovery.Restore_validate" ] }, "POST /api/appliance/recovery/restore/job": { "verb": "POST", "path": "/api/appliance/recovery/restore/job", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "location", "type": "string", "description": "location", "optional": true, "enum": [], "example": "example" }, { "name": "location_type", "type": "string", "description": "location_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "location": "example", "location_type": "example" }, "operation_ids": [ "Appliance.Recovery.Restore.Job_create" ] }, "POST /api/appliance/services/{service}": { "verb": "POST", "path": "/api/appliance/services/{service}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "restart", "start", "stop" ], "example": "restart" } ], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "identifier of the service to restart", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Services_restart", "Appliance.Services_start", "Appliance.Services_stop" ] }, "POST /api/appliance/shutdown": { "verb": "POST", "path": "/api/appliance/shutdown", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "poweroff", "reboot" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Shutdown_cancel", "Appliance.Shutdown_poweroff", "Appliance.Shutdown_reboot" ] }, "POST /api/appliance/support-bundle": { "verb": "POST", "path": "/api/appliance/support-bundle", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Appliance.SupportBundle_create$Task" ] }, "POST /api/appliance/system/storage": { "verb": "POST", "path": "/api/appliance/system/storage", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "resize", "resize-ex" ], "example": "resize" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.System.Storage_resize", "Appliance.System.Storage_resizeEx" ] }, "POST /api/appliance/update": { "verb": "POST", "path": "/api/appliance/update", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update_cancel" ] }, "POST /api/appliance/update/pending": { "verb": "POST", "path": "/api/appliance/update/pending", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "rollback" ], "example": "rollback" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Pending_rollback" ] }, "POST /api/appliance/update/pending/{version}": { "verb": "POST", "path": "/api/appliance/update/pending/{version}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "install", "precheck", "stage", "stage-and-install", "validate" ], "example": "install" } ], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Update version", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Appliance.Update.Pending_install", "Appliance.Update.Pending_precheck", "Appliance.Update.Pending_stage", "Appliance.Update.Pending_stageAndInstall", "Appliance.Update.Pending_validate" ] }, "POST /api/cis/tagging/category": { "verb": "POST", "path": "/api/cis/tagging/category", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "associable_types.0", "type": "string", "description": "associable_types.0", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "cardinality", "type": "string", "description": "cardinality", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "associable_types": [ "example" ], "name": "web-01", "cardinality": "example", "description": "example" }, "operation_ids": [ "Cis.Tagging.Category_create" ] }, "POST /api/cis/tagging/category/{categoryId}": { "verb": "POST", "path": "/api/cis/tagging/category/{categoryId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add-to-used-by", "remove-from-used-by", "revoke-propagating-permissions" ], "example": "add-to-used-by" } ], "path_fields": [ { "name": "categoryId", "type": "string", "optional": false, "description": "The identifier of the input category.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Category_addToUsedBy", "Cis.Tagging.Category_removeFromUsedBy", "Cis.Tagging.Category_revokePropagatingPermissions" ] }, "POST /api/cis/tagging/tag": { "verb": "POST", "path": "/api/cis/tagging/tag", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "category_id", "type": "string", "description": "category_id", "optional": true, "enum": [], "example": "urn:vmomi:InventoryServiceCategory:demo:GLOBAL" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "category_id": "urn:vmomi:InventoryServiceCategory:demo:GLOBAL", "description": "example" }, "operation_ids": [ "Cis.Tagging.Tag_create" ] }, "POST /api/cis/tagging/tag-association": { "verb": "POST", "path": "/api/cis/tagging/tag-association", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "attach-multiple-tags-to-object", "detach-multiple-tags-from-object", "list-attachable-tags", "list-attached-objects-on-tags", "list-attached-tags", "list-attached-tags-on-objects" ], "example": "attach-multiple-tags-to-object" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.TagAssociation_attachMultipleTagsToObject", "Cis.Tagging.TagAssociation_detachMultipleTagsFromObject", "Cis.Tagging.TagAssociation_listAttachableTags", "Cis.Tagging.TagAssociation_listAttachedObjectsOnTags", "Cis.Tagging.TagAssociation_listAttachedTags", "Cis.Tagging.TagAssociation_listAttachedTagsOnObjects" ] }, "POST /api/cis/tagging/tag-association/{tagId}": { "verb": "POST", "path": "/api/cis/tagging/tag-association/{tagId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "attach", "attach-tag-to-multiple-objects", "detach", "detach-tag-from-multiple-objects", "list-attached-objects" ], "example": "attach" } ], "path_fields": [ { "name": "tagId", "type": "string", "optional": false, "description": "The identifier of the input tag.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.TagAssociation_attach", "Cis.Tagging.TagAssociation_attachTagToMultipleObjects", "Cis.Tagging.TagAssociation_detach", "Cis.Tagging.TagAssociation_detachTagFromMultipleObjects", "Cis.Tagging.TagAssociation_listAttachedObjects" ] }, "POST /api/cis/tagging/tag/{tagId}": { "verb": "POST", "path": "/api/cis/tagging/tag/{tagId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add-to-used-by", "remove-from-used-by", "revoke-propagating-permissions" ], "example": "add-to-used-by" } ], "path_fields": [ { "name": "tagId", "type": "string", "optional": false, "description": "The identifier of the input tag.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tagging.Tag_addToUsedBy", "Cis.Tagging.Tag_removeFromUsedBy", "Cis.Tagging.Tag_revokePropagatingPermissions" ] }, "POST /api/cis/tasks": { "verb": "POST", "path": "/api/cis/tasks", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "list" ], "example": "list" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tasks_list" ] }, "POST /api/cis/tasks/{task}": { "verb": "POST", "path": "/api/cis/tasks/{task}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel" ], "example": "cancel" } ], "path_fields": [ { "name": "task", "type": "string", "optional": false, "description": "Task identifier.", "enum": [], "example": "task-1" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Tasks_cancel" ] }, "POST /api/content/library": { "verb": "POST", "path": "/api/content/library", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "find" ], "example": "find" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library_find" ] }, "POST /api/content/library/item": { "verb": "POST", "path": "/api/content/library/item", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.Library.Item_create" ] }, "POST /api/content/library/item/download-session": { "verb": "POST", "path": "/api/content/library/item/download-session", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "id", "type": "string", "description": "id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_id", "type": "string", "description": "library_item_id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_content_version", "type": "string", "description": "library_item_content_version", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.args.0", "type": "string", "description": "error_message.args.0", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.id", "type": "string", "description": "error_message.id", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.default_message", "type": "string", "description": "error_message.default_message", "optional": true, "enum": [], "example": "example" }, { "name": "client_progress", "type": "integer", "description": "client_progress", "optional": true, "enum": [], "example": 1 }, { "name": "state", "type": "string", "description": "state", "optional": true, "enum": [], "example": "example" } ], "body_example": { "id": "example", "library_item_id": "example", "library_item_content_version": "example", "error_message": { "args": [ "example" ], "id": "example", "default_message": "example" }, "client_progress": 1, "state": "example" }, "operation_ids": [ "Content.Library.Item.DownloadSession_create" ] }, "POST /api/content/library/item/download-session/{downloadSessionId}": { "verb": "POST", "path": "/api/content/library/item/download-session/{downloadSessionId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "fail", "keep-alive" ], "example": "cancel" } ], "path_fields": [ { "name": "downloadSessionId", "type": "string", "optional": false, "description": "Identifer of the download session that should be canceled.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.DownloadSession_cancel", "Content.Library.Item.DownloadSession_fail", "Content.Library.Item.DownloadSession_keepAlive" ] }, "POST /api/content/library/item/download-session/{downloadSessionId}/file": { "verb": "POST", "path": "/api/content/library/item/download-session/{downloadSessionId}/file", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "prepare" ], "example": "prepare" } ], "path_fields": [ { "name": "downloadSessionId", "type": "string", "optional": false, "description": "Identifier of the download session.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.Downloadsession.File_prepare" ] }, "POST /api/content/library/item/update-session": { "verb": "POST", "path": "/api/content/library/item/update-session", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "id", "type": "string", "description": "id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_id", "type": "string", "description": "library_item_id", "optional": true, "enum": [], "example": "example" }, { "name": "library_item_content_version", "type": "string", "description": "library_item_content_version", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.args.0", "type": "string", "description": "error_message.args.0", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.id", "type": "string", "description": "error_message.id", "optional": true, "enum": [], "example": "example" }, { "name": "error_message.default_message", "type": "string", "description": "error_message.default_message", "optional": true, "enum": [], "example": "example" }, { "name": "client_progress", "type": "integer", "description": "client_progress", "optional": true, "enum": [], "example": 1 }, { "name": "state", "type": "string", "description": "state", "optional": true, "enum": [], "example": "example" } ], "body_example": { "id": "example", "library_item_id": "example", "library_item_content_version": "example", "error_message": { "args": [ "example" ], "id": "example", "default_message": "example" }, "client_progress": 1, "state": "example" }, "operation_ids": [ "Content.Library.Item.UpdateSession_create" ] }, "POST /api/content/library/item/update-session/{updateSessionId}": { "verb": "POST", "path": "/api/content/library/item/update-session/{updateSessionId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "complete", "fail", "keep-alive" ], "example": "cancel" } ], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session that should be canceled.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item.UpdateSession_cancel", "Content.Library.Item.UpdateSession_complete", "Content.Library.Item.UpdateSession_fail", "Content.Library.Item.UpdateSession_keepAlive" ] }, "POST /api/content/library/item/update-session/{updateSessionId}/file": { "verb": "POST", "path": "/api/content/library/item/update-session/{updateSessionId}/file", "query_fields": [], "path_fields": [ { "name": "updateSessionId", "type": "string", "optional": false, "description": "Identifier of the update session to be modified.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "source_type", "type": "string", "description": "source_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "source_type": "example" }, "operation_ids": [ "Content.Library.Item.Updatesession.File_add" ] }, "POST /api/content/library/item/{libraryItemId}": { "verb": "POST", "path": "/api/content/library/item/{libraryItemId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "publish" ], "example": "publish" } ], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Library item identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item_publish" ] }, "POST /api/content/library/item/{sourceLibraryItemId}": { "verb": "POST", "path": "/api/content/library/item/{sourceLibraryItemId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "copy" ], "example": "copy" } ], "path_fields": [ { "name": "sourceLibraryItemId", "type": "string", "optional": false, "description": "Identifier of the existing library item from which the content will be copied.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.Item_copy" ] }, "POST /api/content/library/subscribed-item/{libraryItemId}": { "verb": "POST", "path": "/api/content/library/subscribed-item/{libraryItemId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "evict", "sync" ], "example": "evict" } ], "path_fields": [ { "name": "libraryItemId", "type": "string", "optional": false, "description": "Identifier of the library item whose content should be evicted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library.SubscribedItem_evict", "Content.Library.SubscribedItem_sync" ] }, "POST /api/content/library/{libraryId}": { "verb": "POST", "path": "/api/content/library/{libraryId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "convert", "enter-maintenance", "exit-maintenance", "force-delete", "migrate" ], "example": "convert" } ], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "The unique identifier of the library to be converted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.Library_convert", "Content.Library_enterMaintenance", "Content.Library_exitMaintenance", "Content.Library_forceDelete", "Content.Library_migrate" ] }, "POST /api/content/library/{library}/subscriptions": { "verb": "POST", "path": "/api/content/library/{library}/subscriptions", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier of the published library.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "subscribed_library.location", "type": "string", "description": "subscribed_library.location", "optional": true, "enum": [], "example": "example" }, { "name": "subscribed_library.target", "type": "string", "description": "subscribed_library.target", "optional": true, "enum": [], "example": "example" }, { "name": "subscribed_library.placement.folder", "type": "string", "description": "subscribed_library.placement.folder", "optional": true, "enum": [], "example": "group-v23" }, { "name": "subscribed_library.placement.cluster", "type": "string", "description": "subscribed_library.placement.cluster", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "subscribed_library.placement.resource_pool", "type": "string", "description": "subscribed_library.placement.resource_pool", "optional": true, "enum": [], "example": "resgroup-22" }, { "name": "subscribed_library.placement.host", "type": "string", "description": "subscribed_library.placement.host", "optional": true, "enum": [], "example": "host-11" }, { "name": "subscribed_library.placement.network", "type": "string", "description": "subscribed_library.placement.network", "optional": true, "enum": [], "example": "network-41" } ], "body_example": { "subscribed_library": { "location": "example", "target": "example", "placement": { "folder": "group-v23", "cluster": "domain-c21", "resource_pool": "resgroup-22", "host": "host-11", "network": "network-41" } } }, "operation_ids": [ "Content.Library.Subscriptions_create" ] }, "POST /api/content/library/{library}/usages": { "verb": "POST", "path": "/api/content/library/{library}/usages", "query_fields": [], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "The identifier of the content library for which the usage needs to be added.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "resource_urn", "type": "string", "description": "resource_urn", "optional": true, "enum": [], "example": "example" } ], "body_example": { "resource_urn": "example" }, "operation_ids": [ "Content.Library.Usages_add" ] }, "POST /api/content/local-library": { "verb": "POST", "path": "/api/content/local-library", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.LocalLibrary_create" ] }, "POST /api/content/local-library/{libraryId}": { "verb": "POST", "path": "/api/content/local-library/{libraryId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "force-delete", "publish" ], "example": "force-delete" } ], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the local library to delete.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.LocalLibrary_forceDelete", "Content.LocalLibrary_publish" ] }, "POST /api/content/subscribed-library": { "verb": "POST", "path": "/api/content/subscribed-library", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "description": "example" }, "operation_ids": [ "Content.SubscribedLibrary_create" ] }, "POST /api/content/subscribed-library/{libraryId}": { "verb": "POST", "path": "/api/content/subscribed-library/{libraryId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "evict", "force-delete", "sync" ], "example": "evict" } ], "path_fields": [ { "name": "libraryId", "type": "string", "optional": false, "description": "Identifier of the subscribed library whose content should be evicted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Content.SubscribedLibrary_evict", "Content.SubscribedLibrary_forceDelete", "Content.SubscribedLibrary_sync" ] }, "POST /api/content/trusted-certificates": { "verb": "POST", "path": "/api/content/trusted-certificates", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cert_text", "type": "string", "description": "cert_text", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cert_text": "example" }, "operation_ids": [ "Content.TrustedCertificates_create" ] }, "POST /api/esx/hcl/compatibility-data": { "verb": "POST", "path": "/api/esx/hcl/compatibility-data", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "download" ], "example": "download" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Hcl.CompatibilityData_update$Task" ] }, "POST /api/esx/hcl/hosts/{host}/compatibility-report": { "verb": "POST", "path": "/api/esx/hcl/hosts/{host}/compatibility-report", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Contains the MoID identifying the ESXi host.", "enum": [], "example": "host-11" } ], "body_fields": [ { "name": "release", "type": "string", "description": "release", "optional": true, "enum": [], "example": "example" } ], "body_example": { "release": "example" }, "operation_ids": [ "Esx.Hcl.Hosts.CompatibilityReport_create$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/configuration": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/configuration", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "checkCompliance", "exportConfig", "importConfig", "precheck", "validate" ], "example": "apply" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration_apply$Task", "Esx.Settings.Clusters.Configuration_checkCompliance$Task", "Esx.Settings.Clusters.Configuration_exportConfig", "Esx.Settings.Clusters.Configuration_importConfig$Task", "Esx.Settings.Clusters.Configuration_precheck$Task", "Esx.Settings.Clusters.Configuration_validate$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/configuration/drafts": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/configuration/drafts", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "config", "type": "string", "description": "config", "optional": true, "enum": [], "example": "example" }, { "name": "image_reference_host", "type": "string", "description": "image_reference_host", "optional": true, "enum": [], "example": "example" } ], "body_example": { "config": "example", "image_reference_host": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Drafts_create" ] }, "POST /api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/configuration/drafts/{draft}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "checkCompliance", "exportConfig", "getAvailableValues", "importConfig", "importFromHost", "precheck", "update" ], "example": "apply" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Configuration.Drafts_apply", "Esx.Settings.Clusters.Configuration.Drafts_checkCompliance$Task", "Esx.Settings.Clusters.Configuration.Drafts_exportConfig", "Esx.Settings.Clusters.Configuration.Drafts_getAvailableValues$Task", "Esx.Settings.Clusters.Configuration.Drafts_importConfig$Task", "Esx.Settings.Clusters.Configuration.Drafts_importFromHost$Task", "Esx.Settings.Clusters.Configuration.Drafts_precheck$Task", "Esx.Settings.Clusters.Configuration.Drafts_update" ] }, "POST /api/esx/settings/clusters/{cluster}/depot-overrides": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/depot-overrides", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add", "remove" ], "example": "add" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.DepotOverrides_add", "Esx.Settings.Clusters.DepotOverrides_remove" ] }, "POST /api/esx/settings/clusters/{cluster}/enablement/configuration/transition": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/enablement/configuration/transition", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "checkEligibility", "enable", "exportConfig", "exportSchema", "importFromFile", "importFromHost", "precheck", "validateConfig" ], "example": "cancel" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Configuration.Transition_cancel", "Esx.Settings.Clusters.Enablement.Configuration.Transition_checkEligibility$Task", "Esx.Settings.Clusters.Enablement.Configuration.Transition_enable$Task", "Esx.Settings.Clusters.Enablement.Configuration.Transition_exportConfig", "Esx.Settings.Clusters.Enablement.Configuration.Transition_exportSchema", "Esx.Settings.Clusters.Enablement.Configuration.Transition_importFromFile", "Esx.Settings.Clusters.Enablement.Configuration.Transition_importFromHost$Task", "Esx.Settings.Clusters.Enablement.Configuration.Transition_precheck$Task", "Esx.Settings.Clusters.Enablement.Configuration.Transition_validateConfig$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/enablement/software": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/enablement/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Software_check$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/installed-images": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/installed-images", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "extract" ], "example": "extract" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.InstalledImages_extract$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/software": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "check", "export", "scan", "stage" ], "example": "apply" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software_apply$Task", "Esx.Settings.Clusters.Software_check$Task", "Esx.Settings.Clusters.Software_export", "Esx.Settings.Clusters.Software_scan$Task", "Esx.Settings.Clusters.Software_stage$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/alternative-images/{image}/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "export" ], "example": "export" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.AlternativeImages.Software_export" ] }, "POST /api/esx/settings/clusters/{cluster}/software/drafts": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/drafts", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "import-software-spec" ], "example": "import-software-spec" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts_create", "Esx.Settings.Clusters.Software.Drafts_importSoftwareSpec" ] }, "POST /api/esx/settings/clusters/{cluster}/software/drafts/{draft}": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "commit", "scan", "validate" ], "example": "commit" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts_commit$Task", "Esx.Settings.Clusters.Software.Drafts_scan$Task", "Esx.Settings.Clusters.Software.Drafts_validate$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages_create" ] }, "POST /api/esx/settings/clusters/{cluster}/software/recommendations": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/recommendations", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "generate" ], "example": "generate" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Recommendations_generate$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/software/reports/hardware-compatibility", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Reports.HardwareCompatibility_check$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/vms/lifecycle-hooks": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/vms/lifecycle-hooks", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "mark-as-processed", "process-dynamic-update" ], "example": "mark-as-processed" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.LifecycleHooks_markAsProcessed", "Esx.Settings.Clusters.Vms.LifecycleHooks_processDynamicUpdate" ] }, "POST /api/esx/settings/clusters/{cluster}/vms/solutions": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/vms/solutions", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "check-compliance" ], "example": "apply" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.Solutions_apply$Task", "Esx.Settings.Clusters.Vms.Solutions_checkCompliance$Task" ] }, "POST /api/esx/settings/clusters/{cluster}/vms/transition/{solution}": { "verb": "POST", "path": "/api/esx/settings/clusters/{cluster}/vms/transition/{solution}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "enable", "multi-source-enable", "transition" ], "example": "enable" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Vms.Transition_enable$Task", "Esx.Settings.Clusters.Vms.Transition_multiSourceEnable$Task", "Esx.Settings.Clusters.Vms.Transition_transition$Task" ] }, "POST /api/esx/settings/depots": { "verb": "POST", "path": "/api/esx/settings/depots", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "sync" ], "example": "sync" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots_sync$Task" ] }, "POST /api/esx/settings/depots/offline": { "verb": "POST", "path": "/api/esx/settings/depots/offline", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "createFromHost" ], "example": "createFromHost" } ], "path_fields": [], "body_fields": [ { "name": "source_type", "type": "string", "description": "source_type", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "source_type": "example", "description": "example" }, "operation_ids": [ "Esx.Settings.Depots.Offline_createFromHost$Task", "Esx.Settings.Depots.Offline_create$Task" ] }, "POST /api/esx/settings/depots/online": { "verb": "POST", "path": "/api/esx/settings/depots/online", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "location", "type": "string", "description": "location", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "location": "example", "description": "example" }, "operation_ids": [ "Esx.Settings.Depots.Online_create" ] }, "POST /api/esx/settings/depots/online/{depot}": { "verb": "POST", "path": "/api/esx/settings/depots/online/{depot}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "flush" ], "example": "flush" } ], "path_fields": [ { "name": "depot", "type": "string", "optional": false, "description": "Identifier of the depot to be removed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Depots.Online_flush$Task" ] }, "POST /api/esx/settings/hosts/{host}/configuration": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/configuration", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "extract" ], "example": "extract" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Configuration_extract" ] }, "POST /api/esx/settings/hosts/{host}/depot-overrides": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/depot-overrides", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add", "remove" ], "example": "add" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier for the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.DepotOverrides_add", "Esx.Settings.Hosts.DepotOverrides_remove" ] }, "POST /api/esx/settings/hosts/{host}/enablement/software": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/enablement/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Enablement.Software_check$Task" ] }, "POST /api/esx/settings/hosts/{host}/software": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "check", "export", "scan", "stage" ], "example": "apply" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software_apply$Task", "Esx.Settings.Hosts.Software_check$Task", "Esx.Settings.Hosts.Software_export", "Esx.Settings.Hosts.Software_scan$Task", "Esx.Settings.Hosts.Software_stage$Task" ] }, "POST /api/esx/settings/hosts/{host}/software/drafts": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/software/drafts", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "import-software-spec" ], "example": "import-software-spec" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts_create", "Esx.Settings.Hosts.Software.Drafts_importSoftwareSpec" ] }, "POST /api/esx/settings/hosts/{host}/software/drafts/{draft}": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "commit", "scan", "validate" ], "example": "commit" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts_commit$Task", "Esx.Settings.Hosts.Software.Drafts_scan$Task", "Esx.Settings.Hosts.Software.Drafts_validate$Task" ] }, "POST /api/esx/settings/hosts/{host}/software/recommendations": { "verb": "POST", "path": "/api/esx/settings/hosts/{host}/software/recommendations", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "generate" ], "example": "generate" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Recommendations_generate$Task" ] }, "POST /api/esx/settings/inventory": { "verb": "POST", "path": "/api/esx/settings/inventory", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "assign-entities", "check", "extract-installed-image", "scan", "stage", "transition", "update-vum-capability" ], "example": "apply" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Inventory_apply$Task", "Esx.Settings.Inventory_assignEntities$Task", "Esx.Settings.Inventory_check$Task", "Esx.Settings.Inventory_extractInstalledImage$Task", "Esx.Settings.Inventory_scan$Task", "Esx.Settings.Inventory_stage$Task", "Esx.Settings.Inventory_transition$Task", "Esx.Settings.Inventory_updateVumCapability$Task" ] }, "POST /api/esx/settings/repository/software": { "verb": "POST", "path": "/api/esx/settings/repository/software", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-repository" ], "example": "check-repository" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software_checkRepository" ] }, "POST /api/esx/settings/repository/software/drafts": { "verb": "POST", "path": "/api/esx/settings/repository/software/drafts", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "delete_existing_draft", "type": "boolean", "description": "delete_existing_draft", "optional": true, "enum": [], "example": false } ], "body_example": { "delete_existing_draft": false }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts_create" ] }, "POST /api/esx/settings/repository/software/drafts/{draft}": { "verb": "POST", "path": "/api/esx/settings/repository/software/drafts/{draft}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "commit", "validate" ], "example": "commit" } ], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy of the document.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts_commit$Task", "Esx.Settings.Repository.Software.Drafts_validate$Task" ] }, "POST /api/esx/settings/repository/software/drafts/{draft}/alternative-images": { "verb": "POST", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages_create" ] }, "POST /api/esx/settings/repository/software/{softwareSpec}": { "verb": "POST", "path": "/api/esx/settings/repository/software/{softwareSpec}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "copy", "edit", "export" ], "example": "copy" } ], "path_fields": [ { "name": "softwareSpec", "type": "string", "optional": false, "description": "Identifier of the software specification in the repository.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software_copy", "Esx.Settings.Repository.Software_edit", "Esx.Settings.Repository.Software_export" ] }, "POST /api/session": { "verb": "POST", "path": "/api/session", "query_fields": [], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Cis.Session_create" ] }, "POST /api/stats/acq-specs": { "verb": "POST", "path": "/api/stats/acq-specs", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "counters.cid_mid.cid", "type": "string", "description": "counters.cid_mid.cid", "optional": true, "enum": [], "example": "example" }, { "name": "counters.set_id", "type": "string", "description": "counters.set_id", "optional": true, "enum": [], "example": "example" }, { "name": "resources.0.id_value", "type": "string", "description": "resources.0.id_value", "optional": true, "enum": [], "example": "example" } ], "body_example": { "counters": { "cid_mid": { "cid": "example" }, "set_id": "example" }, "resources": [ { "id_value": "example" } ] }, "operation_ids": [ "Vstats.AcqSpecs_create" ] }, "POST /api/vapi/metadata/cli/command": { "verb": "POST", "path": "/api/vapi/metadata/cli/command", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get" ], "example": "get" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Command_get" ] }, "POST /api/vapi/metadata/cli/namespace": { "verb": "POST", "path": "/api/vapi/metadata/cli/namespace", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get" ], "example": "get" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vapi.Metadata.Cli.Namespace_get" ] }, "POST /api/vcenter/authentication/token": { "verb": "POST", "path": "/api/vcenter/authentication/token", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "grant_type", "type": "string", "description": "grant_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "grant_type": "example" }, "operation_ids": [ "Vcenter.Authentication.Token_issue" ] }, "POST /api/vcenter/authorization/permissions": { "verb": "POST", "path": "/api/vcenter/authorization/permissions", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "principal.type", "type": "string", "description": "principal.type", "optional": true, "enum": [], "example": "example" }, { "name": "principal.name", "type": "string", "description": "principal.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "propagating", "type": "boolean", "description": "propagating", "optional": true, "enum": [], "example": false }, { "name": "object.type", "type": "string", "description": "object.type", "optional": true, "enum": [], "example": "example" }, { "name": "object.id", "type": "string", "description": "object.id", "optional": true, "enum": [], "example": "example" }, { "name": "role", "type": "string", "description": "role", "optional": true, "enum": [], "example": "example" } ], "body_example": { "principal": { "type": "example", "name": "web-01" }, "propagating": false, "object": { "type": "example", "id": "example" }, "role": "example" }, "operation_ids": [ "Vcenter.Authorization.Permissions_create" ] }, "POST /api/vcenter/authorization/privilege-checks": { "verb": "POST", "path": "/api/vcenter/authorization/privilege-checks", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "list" ], "example": "list" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Authorization.PrivilegeChecks_list" ] }, "POST /api/vcenter/authorization/roles": { "verb": "POST", "path": "/api/vcenter/authorization/roles", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "privileges.0", "type": "string", "description": "privileges.0", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "privileges": [ "example" ], "description": "example" }, "operation_ids": [ "Vcenter.Authorization.Roles_create" ] }, "POST /api/vcenter/authorization/vt-containers/mappings": { "verb": "POST", "path": "/api/vcenter/authorization/vt-containers/mappings", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "vtcontainer", "type": "string", "description": "vtcontainer", "optional": true, "enum": [], "example": "example" }, { "name": "object.type", "type": "string", "description": "object.type", "optional": true, "enum": [], "example": "example" }, { "name": "object.id", "type": "string", "description": "object.id", "optional": true, "enum": [], "example": "example" } ], "body_example": { "vtcontainer": "example", "object": { "type": "example", "id": "example" } }, "operation_ids": [ "Vcenter.Authorization.VtContainers.Mappings_create" ] }, "POST /api/vcenter/certificate-management/vcenter/signing-certificate": { "verb": "POST", "path": "/api/vcenter/certificate-management/vcenter/signing-certificate", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "refresh" ], "example": "refresh" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.SigningCertificate_refresh" ] }, "POST /api/vcenter/certificate-management/vcenter/tls": { "verb": "POST", "path": "/api/vcenter/certificate-management/vcenter/tls", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "renew", "replace-vmca-signed" ], "example": "renew" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.Tls_renew", "Vcenter.CertificateManagement.Vcenter.Tls_replaceVmcaSigned" ] }, "POST /api/vcenter/certificate-management/vcenter/tls-csr": { "verb": "POST", "path": "/api/vcenter/certificate-management/vcenter/tls-csr", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "country", "type": "string", "description": "country", "optional": true, "enum": [], "example": "example" }, { "name": "email_address", "type": "string", "description": "email_address", "optional": true, "enum": [], "example": "example" }, { "name": "state_or_province", "type": "string", "description": "state_or_province", "optional": true, "enum": [], "example": "example" }, { "name": "locality", "type": "string", "description": "locality", "optional": true, "enum": [], "example": "example" }, { "name": "organization", "type": "string", "description": "organization", "optional": true, "enum": [], "example": "example" }, { "name": "organization_unit", "type": "string", "description": "organization_unit", "optional": true, "enum": [], "example": "example" } ], "body_example": { "country": "example", "email_address": "example", "state_or_province": "example", "locality": "example", "organization": "example", "organization_unit": "example" }, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.TlsCsr_create" ] }, "POST /api/vcenter/certificate-management/vcenter/trusted-root-chains": { "verb": "POST", "path": "/api/vcenter/certificate-management/vcenter/trusted-root-chains", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cert_chain.cert_chain.0", "type": "string", "description": "cert_chain.cert_chain.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cert_chain": { "cert_chain": [ "example" ] } }, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.TrustedRootChains_create" ] }, "POST /api/vcenter/certificate-management/vcenter/vmca-root": { "verb": "POST", "path": "/api/vcenter/certificate-management/vcenter/vmca-root", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "key_size", "type": "integer", "description": "key_size", "optional": true, "enum": [], "example": 1 }, { "name": "common_name", "type": "string", "description": "common_name", "optional": true, "enum": [], "example": "example" }, { "name": "organization", "type": "string", "description": "organization", "optional": true, "enum": [], "example": "example" }, { "name": "organization_unit", "type": "string", "description": "organization_unit", "optional": true, "enum": [], "example": "example" }, { "name": "locality", "type": "string", "description": "locality", "optional": true, "enum": [], "example": "example" }, { "name": "state_or_province", "type": "string", "description": "state_or_province", "optional": true, "enum": [], "example": "example" } ], "body_example": { "key_size": 1, "common_name": "example", "organization": "example", "organization_unit": "example", "locality": "example", "state_or_province": "example" }, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.VmcaRoot_create" ] }, "POST /api/vcenter/cluster/{cluster}/evc-mode": { "verb": "POST", "path": "/api/vcenter/cluster/{cluster}/evc-mode", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-add-host-evc", "check-set" ], "example": "check-add-host-evc" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Cluster.EvcMode_checkAddHostEvc$Task", "Vcenter.Cluster.EvcMode_checkSet$Task" ] }, "POST /api/vcenter/compute/policies": { "verb": "POST", "path": "/api/vcenter/compute/policies", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "capability", "type": "string", "description": "capability", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "capability": "example", "description": "example" }, "operation_ids": [ "Vcenter.Compute.Policies_create" ] }, "POST /api/vcenter/confidential-computing/sgx/hosts": { "verb": "POST", "path": "/api/vcenter/confidential-computing/sgx/hosts", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "register" ], "example": "register" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConfidentialComputing.Sgx.Hosts_register$Task" ] }, "POST /api/vcenter/consumption-domains/zone-associations/association-changes": { "verb": "POST", "path": "/api/vcenter/consumption-domains/zone-associations/association-changes", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.ZoneAssociations.AssociationChanges_list" ] }, "POST /api/vcenter/consumption-domains/zones": { "verb": "POST", "path": "/api/vcenter/consumption-domains/zones", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "zone", "type": "string", "description": "zone", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "zone": "example", "description": "example" }, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones_create" ] }, "POST /api/vcenter/consumption-domains/zones/cluster/{zone}/associations": { "verb": "POST", "path": "/api/vcenter/consumption-domains/zones/cluster/{zone}/associations", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add", "evacuate-and-remove", "remove" ], "example": "add" } ], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone to be mapped to the specified vSphere clusters.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones.Cluster.Associations_add", "Vcenter.ConsumptionDomains.Zones.Cluster.Associations_evacuateAndRemove$Task", "Vcenter.ConsumptionDomains.Zones.Cluster.Associations_remove" ] }, "POST /api/vcenter/consumption-domains/zones/{zone}/capacity/summary": { "verb": "POST", "path": "/api/vcenter/consumption-domains/zones/{zone}/capacity/summary", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get-per-cluster" ], "example": "get-per-cluster" } ], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "Identifier of the zone from which to retrieve the resource capacity.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.ConsumptionDomains.Zones.Capacity.Summary_getPerCluster" ] }, "POST /api/vcenter/content/registries/harbor": { "verb": "POST", "path": "/api/vcenter/content/registries/harbor", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "storage.0.policy", "type": "string", "description": "storage.0.policy", "optional": true, "enum": [], "example": "example" } ], "body_example": { "storage": [ { "policy": "example" } ] }, "operation_ids": [ "Vcenter.Content.Registries.Harbor_create" ] }, "POST /api/vcenter/content/registries/harbor/{registry}/projects": { "verb": "POST", "path": "/api/vcenter/content/registries/harbor/{registry}/projects", "query_fields": [], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the Registry.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "scope", "type": "string", "description": "scope", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "scope": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.Content.Registries.Harbor.Projects_create" ] }, "POST /api/vcenter/content/registries/harbor/{registry}/projects/{project}": { "verb": "POST", "path": "/api/vcenter/content/registries/harbor/{registry}/projects/{project}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "purge" ], "example": "purge" } ], "path_fields": [ { "name": "registry", "type": "string", "optional": false, "description": "Identifier of the registry.", "enum": [], "example": "example" }, { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Harbor project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Content.Registries.Harbor.Projects_purge" ] }, "POST /api/vcenter/crypto-manager/kms/providers": { "verb": "POST", "path": "/api/vcenter/crypto-manager/kms/providers", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" } ], "body_example": { "provider": "example" }, "operation_ids": [ "Vcenter.CryptoManager.Kms.Providers_create" ] }, "POST /api/vcenter/datacenter": { "verb": "POST", "path": "/api/vcenter/datacenter", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.Datacenter_create" ] }, "POST /api/vcenter/deployment": { "verb": "POST", "path": "/api/vcenter/deployment", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "rollback" ], "example": "rollback" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment_rollback" ] }, "POST /api/vcenter/deployment/history": { "verb": "POST", "path": "/api/vcenter/deployment/history", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "pause", "resume", "start" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.ImportHistory_cancel", "Vcenter.Deployment.ImportHistory_pause", "Vcenter.Deployment.ImportHistory_resume", "Vcenter.Deployment.ImportHistory_start" ] }, "POST /api/vcenter/deployment/install": { "verb": "POST", "path": "/api/vcenter/deployment/install", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "check", "start" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install_cancel", "Vcenter.Deployment.Install_check", "Vcenter.Deployment.Install_start" ] }, "POST /api/vcenter/deployment/install/psc/replicated": { "verb": "POST", "path": "/api/vcenter/deployment/install/psc/replicated", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install.Psc.Replicated_check" ] }, "POST /api/vcenter/deployment/install/psc/standalone": { "verb": "POST", "path": "/api/vcenter/deployment/install/psc/standalone", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install.Psc.Standalone_check" ] }, "POST /api/vcenter/deployment/install/remote-psc": { "verb": "POST", "path": "/api/vcenter/deployment/install/remote-psc", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Install.RemotePsc_check" ] }, "POST /api/vcenter/deployment/migrate": { "verb": "POST", "path": "/api/vcenter/deployment/migrate", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "check", "start" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Migrate_cancel", "Vcenter.Deployment.Migrate_check", "Vcenter.Deployment.Migrate_start" ] }, "POST /api/vcenter/deployment/migrate/active-directory": { "verb": "POST", "path": "/api/vcenter/deployment/migrate/active-directory", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Migrate.ActiveDirectory_check" ] }, "POST /api/vcenter/deployment/question": { "verb": "POST", "path": "/api/vcenter/deployment/question", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "answer" ], "example": "answer" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Question_answer" ] }, "POST /api/vcenter/deployment/upgrade": { "verb": "POST", "path": "/api/vcenter/deployment/upgrade", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "cancel", "check", "start" ], "example": "cancel" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Deployment.Upgrade_cancel", "Vcenter.Deployment.Upgrade_check", "Vcenter.Deployment.Upgrade_start" ] }, "POST /api/vcenter/evc-modes": { "verb": "POST", "path": "/api/vcenter/evc-modes", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "partition" ], "example": "partition" } ], "path_fields": [], "body_fields": [ { "name": "sources.0.clusters.0", "type": "string", "description": "sources.0.clusters.0", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "sources.0.hosts.0", "type": "string", "description": "sources.0.hosts.0", "optional": true, "enum": [], "example": "host-11" } ], "body_example": { "sources": [ { "service_locator": {}, "clusters": [ "domain-c21" ], "hosts": [ "host-11" ] } ] }, "operation_ids": [ "Vcenter.EvcModes_partition", "Vcenter.EvcModes_create$Task" ] }, "POST /api/vcenter/foundation-load-balancers/{foundationLoadBalancer}": { "verb": "POST", "path": "/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "reset-password" ], "example": "reset-password" } ], "path_fields": [ { "name": "foundationLoadBalancer", "type": "string", "optional": false, "description": "identifier of the load balancer.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers_resetPassword" ] }, "POST /api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes/{nodeId}": { "verb": "POST", "path": "/api/vcenter/foundation-load-balancers/{foundationLoadBalancer}/nodes/{nodeId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "enter-maintenance-mode", "exit-maintenance-mode", "redeploy" ], "example": "enter-maintenance-mode" } ], "path_fields": [ { "name": "foundationLoadBalancer", "type": "string", "optional": false, "description": "identifier of the load balancer.", "enum": [], "example": "example" }, { "name": "nodeId", "type": "string", "optional": false, "description": "identifier of load balancer node to put in maintenance mode.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.FoundationLoadBalancers.Nodes_enterMaintenanceMode", "Vcenter.FoundationLoadBalancers.Nodes_exitMaintenanceMode", "Vcenter.FoundationLoadBalancers.Nodes_redeploy" ] }, "POST /api/vcenter/guest/customization-specs": { "verb": "POST", "path": "/api/vcenter/guest/customization-specs", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "spec.global_dns_settings.dns_suffix_list.0", "type": "string", "description": "spec.global_dns_settings.dns_suffix_list.0", "optional": true, "enum": [], "example": "example" }, { "name": "spec.global_dns_settings.dns_servers.0", "type": "string", "description": "spec.global_dns_settings.dns_servers.0", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "spec": { "configuration_spec": { "windows_config": {}, "linux_config": {}, "cloud_config": {} }, "global_dns_settings": { "dns_suffix_list": [ "example" ], "dns_servers": [ "example" ] }, "interfaces": [ {} ] }, "description": "example" }, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_create" ] }, "POST /api/vcenter/guest/customization-specs/{name}": { "verb": "POST", "path": "/api/vcenter/guest/customization-specs/{name}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "export" ], "example": "export" } ], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "The name of the customization specification that has to be returned.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_export" ] }, "POST /api/vcenter/host": { "verb": "POST", "path": "/api/vcenter/host", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "password", "type": "string", "description": "password", "optional": true, "enum": [], "example": "example" }, { "name": "user_name", "type": "string", "description": "user_name", "optional": true, "enum": [], "example": "example" }, { "name": "hostname", "type": "string", "description": "hostname", "optional": true, "enum": [], "example": "example" }, { "name": "thumbprint_verification", "type": "string", "description": "thumbprint_verification", "optional": true, "enum": [], "example": "example" } ], "body_example": { "password": "example", "user_name": "example", "hostname": "example", "thumbprint_verification": "example" }, "operation_ids": [ "Vcenter.Host_create" ] }, "POST /api/vcenter/host/{host}": { "verb": "POST", "path": "/api/vcenter/host/{host}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host to be reconnected.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host_connect", "Vcenter.Host_disconnect" ] }, "POST /api/vcenter/host/{host}/entropy/external-pool": { "verb": "POST", "path": "/api/vcenter/host/{host}/entropy/external-pool", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "add" ], "example": "add" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host.Entropy.ExternalPool_add" ] }, "POST /api/vcenter/host/{host}/hardware/direct-path-devices": { "verb": "POST", "path": "/api/vcenter/host/{host}/hardware/direct-path-devices", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "configure" ], "example": "configure" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host which has the specified DirectPath device.", "enum": [], "example": "host-11" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Host.Hardware.DirectPathDevices_configure$Task" ] }, "POST /api/vcenter/identity/providers": { "verb": "POST", "path": "/api/vcenter/identity/providers", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "config_tag", "type": "string", "description": "config_tag", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "config_tag": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.Identity.Providers_create" ] }, "POST /api/vcenter/iso/image": { "verb": "POST", "path": "/api/vcenter/iso/image", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "mount", "unmount" ], "example": "mount" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Iso.Image_mount", "Vcenter.Iso.Image_unmount" ] }, "POST /api/vcenter/lcm/deployment/migration-upgrade": { "verb": "POST", "path": "/api/vcenter/lcm/deployment/migration-upgrade", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "apply", "cancel", "check" ], "example": "apply" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Deployment.MigrationUpgrade_apply", "Vcenter.Lcm.Deployment.MigrationUpgrade_cancel", "Vcenter.Lcm.Deployment.MigrationUpgrade_check$Task" ] }, "POST /api/vcenter/lcm/discovery/associated-products": { "verb": "POST", "path": "/api/vcenter/lcm/discovery/associated-products", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "product_name", "type": "string", "description": "product_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example", "product_name": "example" }, "operation_ids": [ "Vcenter.Lcm.Discovery.AssociatedProducts_create" ] }, "POST /api/vcenter/lcm/discovery/interop-report": { "verb": "POST", "path": "/api/vcenter/lcm/discovery/interop-report", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "target_version", "type": "string", "description": "target_version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "target_version": "example" }, "operation_ids": [ "Vcenter.Lcm.Discovery.InteropReport_create$Task" ] }, "POST /api/vcenter/lcm/update/pending/{version}/precheck-report": { "verb": "POST", "path": "/api/vcenter/lcm/update/pending/{version}/precheck-report", "query_fields": [], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Pending update version for which pre-update compatibility check will be executed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Lcm.Update.PrecheckReport_create$Task" ] }, "POST /api/vcenter/namespace-management/clusters/{cluster}": { "verb": "POST", "path": "/api/vcenter/namespace-management/clusters/{cluster}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "disable", "enable", "rotate_password" ], "example": "disable" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster for which vSphere Namespaces will be disabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters_disable", "Vcenter.NamespaceManagement.Clusters_enable", "Vcenter.NamespaceManagement.Clusters_rotatePassword" ] }, "POST /api/vcenter/namespace-management/clusters/{cluster}/networks": { "verb": "POST", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" }, { "name": "network", "type": "string", "description": "network", "optional": true, "enum": [], "example": "network-41" } ], "body_example": { "network_provider": "example", "network": "network-41" }, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_create" ] }, "POST /api/vcenter/namespace-management/clusters/{cluster}/supervisor-services": { "verb": "POST", "path": "/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which to install the service.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "supervisor_service", "type": "string", "description": "supervisor_service", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example", "supervisor_service": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.ClusterSupervisorServices_create" ] }, "POST /api/vcenter/namespace-management/clusters/{cluster}/support-bundle": { "verb": "POST", "path": "/api/vcenter/namespace-management/clusters/{cluster}/support-bundle", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of a vSphere cluster backing a Supervisor for which the support bundle should be generated. Support bundles will be collected from other clusters ...", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.SupportBundle_create" ] }, "POST /api/vcenter/namespace-management/infrastructure-policies": { "verb": "POST", "path": "/api/vcenter/namespace-management/infrastructure-policies", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "policy", "type": "string", "description": "policy", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "policy": "example", "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.InfrastructurePolicies_create" ] }, "POST /api/vcenter/namespace-management/lifecycle/content/libraries/{library}": { "verb": "POST", "path": "/api/vcenter/namespace-management/lifecycle/content/libraries/{library}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "unassign" ], "example": "unassign" } ], "path_fields": [ { "name": "library", "type": "string", "optional": false, "description": "Identifier for the Content Library.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Lifecycle.Content.Libraries_unassign" ] }, "POST /api/vcenter/namespace-management/networks/nsx/distributed-switches": { "verb": "POST", "path": "/api/vcenter/namespace-management/networks/nsx/distributed-switches", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check_compatibility" ], "example": "check_compatibility" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.DistributedSwitches.Compatibility_check" ] }, "POST /api/vcenter/namespace-management/networks/nsx/edges": { "verb": "POST", "path": "/api/vcenter/namespace-management/networks/nsx/edges", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check_compatibility" ], "example": "check_compatibility" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Edges.Compatibility_check" ] }, "POST /api/vcenter/namespace-management/networks/nsx/projects/{project}": { "verb": "POST", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-compatibility" ], "example": "check-compatibility" } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.Compatibility_check" ] }, "POST /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles/{profile}": { "verb": "POST", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpc-connectivity-profiles/{profile}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-compatibility" ], "example": "check-compatibility" } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" }, { "name": "profile", "type": "string", "optional": false, "description": "Identifier of the VPC Connectivity Profile.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.Vpcconnectivityprofiles.Compatibility_check" ] }, "POST /api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs/{vpc}": { "verb": "POST", "path": "/api/vcenter/namespace-management/networks/nsx/projects/{project}/vpcs/{vpc}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-compatibility" ], "example": "check-compatibility" } ], "path_fields": [ { "name": "project", "type": "string", "optional": false, "description": "Identifier of the Project.", "enum": [], "example": "example" }, { "name": "vpc", "type": "string", "optional": false, "description": "Identifier of the VPC.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Networks.Nsx.Projects.Vpcs.Compatibility_check" ] }, "POST /api/vcenter/namespace-management/software/clusters": { "verb": "POST", "path": "/api/vcenter/namespace-management/software/clusters", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "upgradeMultiple" ], "example": "upgradeMultiple" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Clusters_upgradeMultiple" ] }, "POST /api/vcenter/namespace-management/software/clusters/{cluster}": { "verb": "POST", "path": "/api/vcenter/namespace-management/software/clusters/{cluster}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "upgrade" ], "example": "upgrade" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster which will be upgraded.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Clusters_upgrade" ] }, "POST /api/vcenter/namespace-management/software/supervisors/upgrades/jobs/{supervisor}": { "verb": "POST", "path": "/api/vcenter/namespace-management/software/supervisors/upgrades/jobs/{supervisor}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor to be upgraded.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "desired_version", "type": "string", "description": "desired_version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "desired_version": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Upgrades.Jobs_create" ] }, "POST /api/vcenter/namespace-management/software/supervisors/versions/{version}": { "verb": "POST", "path": "/api/vcenter/namespace-management/software/supervisors/versions/{version}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-compatibility" ], "example": "check-compatibility" } ], "path_fields": [ { "name": "version", "type": "string", "optional": false, "description": "Identifier of the Supervisor version.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Versions_checkCompatibility" ] }, "POST /api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks": { "verb": "POST", "path": "/api/vcenter/namespace-management/software/supervisors/{supervisor}/prechecks", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "run" ], "example": "run" } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the supervisor on which upgraded pre-checks are run.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Software.Supervisors.Prechecks_run" ] }, "POST /api/vcenter/namespace-management/storage/profiles": { "verb": "POST", "path": "/api/vcenter/namespace-management/storage/profiles", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check_compatibility" ], "example": "check_compatibility" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Storage.Profiles_check" ] }, "POST /api/vcenter/namespace-management/supervisor-services": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisor-services", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "custom_spec.version_spec.version", "type": "string", "description": "custom_spec.version_spec.version", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.version_spec.display_name", "type": "string", "description": "custom_spec.version_spec.display_name", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.version_spec.content", "type": "string", "description": "custom_spec.version_spec.content", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.version_spec.description", "type": "string", "description": "custom_spec.version_spec.description", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.display_name", "type": "string", "description": "custom_spec.display_name", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.supervisor_service", "type": "string", "description": "custom_spec.supervisor_service", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.description", "type": "string", "description": "custom_spec.description", "optional": true, "enum": [], "example": "example" }, { "name": "vsphere_spec.version_spec.content", "type": "string", "description": "vsphere_spec.version_spec.content", "optional": true, "enum": [], "example": "example" }, { "name": "carvel_spec.version_spec.content", "type": "string", "description": "carvel_spec.version_spec.content", "optional": true, "enum": [], "example": "example" } ], "body_example": { "custom_spec": { "version_spec": { "version": "example", "display_name": "example", "content": "example", "description": "example" }, "display_name": "example", "supervisor_service": "example", "description": "example" }, "vsphere_spec": { "version_spec": { "content": "example" } }, "carvel_spec": { "version_spec": { "content": "example" } } }, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices_create" ] }, "POST /api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisor-services/{supervisorService}/versions", "query_fields": [], "path_fields": [ { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier of the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "custom_spec.version", "type": "string", "description": "custom_spec.version", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.display_name", "type": "string", "description": "custom_spec.display_name", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.content", "type": "string", "description": "custom_spec.content", "optional": true, "enum": [], "example": "example" }, { "name": "custom_spec.description", "type": "string", "description": "custom_spec.description", "optional": true, "enum": [], "example": "example" }, { "name": "vsphere_spec.content", "type": "string", "description": "vsphere_spec.content", "optional": true, "enum": [], "example": "example" }, { "name": "carvel_spec.content", "type": "string", "description": "carvel_spec.content", "optional": true, "enum": [], "example": "example" } ], "body_example": { "custom_spec": { "version": "example", "display_name": "example", "content": "example", "description": "example" }, "vsphere_spec": { "content": "example" }, "carvel_spec": { "content": "example" } }, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.Versions_create" ] }, "POST /api/vcenter/namespace-management/supervisors": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "enable_on_zones" ], "example": "enable_on_zones" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors_enableOnZones" ] }, "POST /api/vcenter/namespace-management/supervisors/{cluster}": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{cluster}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "enable_on_compute_cluster" ], "example": "enable_on_compute_cluster" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster used to enable the Supervisor Cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors_enableOnComputeCluster" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/certificates/signing-requests": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/certificates/signing-requests", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "common_name", "type": "string", "description": "common_name", "optional": true, "enum": [], "example": "example" }, { "name": "country", "type": "string", "description": "country", "optional": true, "enum": [], "example": "example" }, { "name": "organization_name", "type": "string", "description": "organization_name", "optional": true, "enum": [], "example": "example" }, { "name": "organization_unit_name", "type": "string", "description": "organization_unit_name", "optional": true, "enum": [], "example": "example" }, { "name": "state_or_province", "type": "string", "description": "state_or_province", "optional": true, "enum": [], "example": "example" }, { "name": "csr_type", "type": "string", "description": "csr_type", "optional": true, "enum": [], "example": "example" }, { "name": "locality", "type": "string", "description": "locality", "optional": true, "enum": [], "example": "example" } ], "body_example": { "common_name": "example", "country": "example", "organization_name": "example", "organization_unit_name": "example", "state_or_province": "example", "csr_type": "example", "locality": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Certificates.SigningRequests_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/container-image-registries", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which the container image registry is created.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "image_registry.hostname", "type": "string", "description": "image_registry.hostname", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "image_registry": { "hostname": "example" }, "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ContainerImageRegistries_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/passwords": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/control-plane/passwords", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "reset" ], "example": "reset" } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor for which the password is being generated.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ControlPlane.Passwords_reset" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the Supervisor for which the identity provider is being registered.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "client_id", "type": "string", "description": "client_id", "optional": true, "enum": [], "example": "example" }, { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" }, { "name": "issuer_url", "type": "string", "description": "issuer_url", "optional": true, "enum": [], "example": "example" }, { "name": "client_secret", "type": "string", "description": "client_secret", "optional": true, "enum": [], "example": "example" } ], "body_example": { "client_id": "example", "display_name": "example", "issuer_url": "example", "client_secret": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/management-services": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/management-services", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "management_addresses.0", "type": "string", "description": "management_addresses.0", "optional": true, "enum": [], "example": "example" }, { "name": "ports.0.transport_protocol", "type": "string", "description": "ports.0.transport_protocol", "optional": true, "enum": [], "example": "example" }, { "name": "ports.0.port", "type": "integer", "description": "ports.0.port", "optional": true, "enum": [], "example": 1 }, { "name": "ports.0.name", "type": "string", "description": "ports.0.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "management_service", "type": "string", "description": "management_service", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "management_addresses": [ "example" ], "ports": [ { "transport_protocol": "example", "port": 1, "name": "web-01" } ], "management_service": "example", "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.ManagementServices_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier of the Supervisor for which the remote endpoint is being created.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "remote_endpoint_type", "type": "string", "description": "remote_endpoint_type", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "remote_endpoint_type": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/networks": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" }, { "name": "network", "type": "string", "description": "network", "optional": true, "enum": [], "example": "network-41" } ], "body_example": { "network_provider": "example", "network": "network-41" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/networks/edges", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "The unique identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "provider": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Networks.Edges_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/recovery/backup/jobs": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/recovery/backup/jobs", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "comment", "type": "string", "description": "comment", "optional": true, "enum": [], "example": "example" }, { "name": "ignore_health_check_failure", "type": "boolean", "description": "ignore_health_check_failure", "optional": true, "enum": [], "example": false } ], "body_example": { "comment": "example", "ignore_health_check_failure": false }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Recovery.Backup.Jobs_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/recovery/restore/jobs/{archive}": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/recovery/restore/jobs/{archive}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "archive", "type": "string", "optional": false, "description": "Identifier for the Backup archive to restore from.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Recovery.Restore.Jobs_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/storage/cloud-native/resource-checks": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/storage/cloud-native/resource-checks", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "operation", "type": "string", "description": "operation", "optional": true, "enum": [], "example": "example" } ], "body_example": { "operation": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Storage.CloudNative.ResourceChecks_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "supervisor_service", "type": "string", "description": "supervisor_service", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example", "supervisor_service": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "precheck" ], "example": "precheck" } ], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor on which to initiate the pre-check.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier of the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_precheck" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/support-bundles": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/support-bundles", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier of the Supervisor", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupportBundles_create" ] }, "POST /api/vcenter/namespace-management/supervisors/{supervisor}/zones/bindings": { "verb": "POST", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/zones/bindings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "specs.0.zone", "type": "string", "description": "specs.0.zone", "optional": true, "enum": [], "example": "example" } ], "body_example": { "specs": [ { "zone": "example" } ] }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Zones.Bindings_create" ] }, "POST /api/vcenter/namespace-management/virtual-machine-classes": { "verb": "POST", "path": "/api/vcenter/namespace-management/virtual-machine-classes", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cpu_count", "type": "integer", "description": "cpu_count", "optional": true, "enum": [], "example": 2 }, { "name": "id", "type": "string", "description": "id", "optional": true, "enum": [], "example": "example" }, { "name": "memory_mb", "type": "integer", "description": "memory_mb", "optional": true, "enum": [], "example": 1 }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cpu_count": 2, "id": "example", "memory_mb": 1, "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.VirtualMachineClasses_create" ] }, "POST /api/vcenter/namespace-management/zones/{zone}/cluster-compatibilities": { "verb": "POST", "path": "/api/vcenter/namespace-management/zones/{zone}/cluster-compatibilities", "query_fields": [], "path_fields": [ { "name": "zone", "type": "string", "optional": false, "description": "The identifier of the existing vSphere Zone.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "clusters.0", "type": "string", "description": "clusters.0", "optional": true, "enum": [], "example": "domain-c21" } ], "body_example": { "clusters": [ "domain-c21" ] }, "operation_ids": [ "Vcenter.NamespaceManagement.Zones.ClusterCompatibilities_create" ] }, "POST /api/vcenter/namespaces/instances": { "verb": "POST", "path": "/api/vcenter/namespaces/instances", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cluster", "type": "string", "description": "cluster", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "namespace", "type": "string", "description": "namespace", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cluster": "domain-c21", "namespace": "example", "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.Instances_create" ] }, "POST /api/vcenter/namespaces/instances/v2": { "verb": "POST", "path": "/api/vcenter/namespaces/instances/v2", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "namespace", "type": "string", "description": "namespace", "optional": true, "enum": [], "example": "example" }, { "name": "supervisor", "type": "string", "description": "supervisor", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "namespace": "example", "supervisor": "example", "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.Instances_createV2" ] }, "POST /api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}": { "verb": "POST", "path": "/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}", "query_fields": [ { "name": "type", "type": "string", "optional": false, "description": "The type of subject (USER or GROUP).", "enum": [], "example": "example" } ], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "domain", "type": "string", "optional": false, "description": "The domain of the subject.", "enum": [], "example": "example" }, { "name": "subject", "type": "string", "optional": false, "description": "The principal for this operation.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "role", "type": "string", "description": "role", "optional": true, "enum": [], "example": "example" } ], "body_example": { "role": "example" }, "operation_ids": [ "Vcenter.Namespaces.Access_create" ] }, "POST /api/vcenter/namespaces/instances/{namespace}/registervm": { "verb": "POST", "path": "/api/vcenter/namespaces/instances/{namespace}/registervm", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "vm", "type": "string", "description": "vm", "optional": true, "enum": [], "example": "vm-101" } ], "body_example": { "vm": "vm-101" }, "operation_ids": [ "Vcenter.Namespaces.Instances_registerVM" ] }, "POST /api/vcenter/namespaces/namespace-self-service/{cluster}": { "verb": "POST", "path": "/api/vcenter/namespaces/namespace-self-service/{cluster}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "activate", "activateWithTemplate", "deactivate" ], "example": "activate" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces will be enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Namespaces.NamespaceSelfService_activate", "Vcenter.Namespaces.NamespaceSelfService_activateWithTemplate", "Vcenter.Namespaces.NamespaceSelfService_deactivate" ] }, "POST /api/vcenter/namespaces/namespace-templates/clusters/{cluster}": { "verb": "POST", "path": "/api/vcenter/namespaces/namespace-templates/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces are enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "storage_specs.0.policy", "type": "string", "description": "storage_specs.0.policy", "optional": true, "enum": [], "example": "example" }, { "name": "template", "type": "string", "description": "template", "optional": true, "enum": [], "example": "example" } ], "body_example": { "storage_specs": [ { "policy": "example" } ], "template": "example", "resource_spec": {} }, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_create" ] }, "POST /api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}": { "verb": "POST", "path": "/api/vcenter/namespaces/namespace-templates/supervisors/{supervisor}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "storage_specs.0.policy", "type": "string", "description": "storage_specs.0.policy", "optional": true, "enum": [], "example": "example" }, { "name": "template", "type": "string", "description": "template", "optional": true, "enum": [], "example": "example" } ], "body_example": { "storage_specs": [ { "policy": "example" } ], "template": "example", "resource_spec": {} }, "operation_ids": [ "Vcenter.Namespaces.NamespaceTemplates_createV2" ] }, "POST /api/vcenter/namespaces/{namespace}/management-services/access-grants": { "verb": "POST", "path": "/api/vcenter/namespaces/{namespace}/management-services/access-grants", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier of the namespace.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "workload_selector.type", "type": "string", "description": "workload_selector.type", "optional": true, "enum": [], "example": "example" }, { "name": "management_service", "type": "string", "description": "management_service", "optional": true, "enum": [], "example": "example" }, { "name": "access_grant", "type": "string", "description": "access_grant", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "workload_selector": { "type": "example" }, "management_service": "example", "access_grant": "example", "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.ManagementServices.AccessGrants_create" ] }, "POST /api/vcenter/namespaces/{namespace}/mobility/virtualmachines/imports": { "verb": "POST", "path": "/api/vcenter/namespaces/{namespace}/mobility/virtualmachines/imports", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "vm", "type": "string", "description": "vm", "optional": true, "enum": [], "example": "vm-101" } ], "body_example": { "vm": "vm-101" }, "operation_ids": [ "Vcenter.Namespaces.Mobility.Virtualmachines.Imports_create" ] }, "POST /api/vcenter/ovf/library-item": { "verb": "POST", "path": "/api/vcenter/ovf/library-item", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "source.type", "type": "string", "description": "source.type", "optional": true, "enum": [], "example": "example" }, { "name": "source.id", "type": "string", "description": "source.id", "optional": true, "enum": [], "example": "example" }, { "name": "create_spec.name", "type": "string", "description": "create_spec.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "create_spec.description", "type": "string", "description": "create_spec.description", "optional": true, "enum": [], "example": "example" }, { "name": "target.library_id", "type": "string", "description": "target.library_id", "optional": true, "enum": [], "example": "library-demo" }, { "name": "target.library_item_id", "type": "string", "description": "target.library_item_id", "optional": true, "enum": [], "example": "example" } ], "body_example": { "source": { "type": "example", "id": "example" }, "create_spec": { "name": "web-01", "description": "example" }, "target": { "library_id": "library-demo", "library_item_id": "example" } }, "operation_ids": [ "Vcenter.Ovf.LibraryItem_create" ] }, "POST /api/vcenter/ovf/library-item/{ovfLibraryItemId}": { "verb": "POST", "path": "/api/vcenter/ovf/library-item/{ovfLibraryItemId}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "deploy", "filter" ], "example": "deploy" } ], "path_fields": [ { "name": "ovfLibraryItemId", "type": "string", "optional": false, "description": "Identifier of the content library item containing the OVF package to be deployed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Ovf.LibraryItem_deploy", "Vcenter.Ovf.LibraryItem_filter" ] }, "POST /api/vcenter/ovfs": { "verb": "POST", "path": "/api/vcenter/ovfs", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "deploy" ], "example": "deploy" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Ovfs_deploy$Task" ] }, "POST /api/vcenter/phm/hardware-support-managers": { "verb": "POST", "path": "/api/vcenter/phm/hardware-support-managers", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "key", "type": "string", "description": "key", "optional": true, "enum": [], "example": "example" }, { "name": "base_url", "type": "string", "description": "base_url", "optional": true, "enum": [], "example": "example" }, { "name": "health_update_info_default_configs.0.default_enabled", "type": "boolean", "description": "health_update_info_default_configs.0.default_enabled", "optional": true, "enum": [], "example": false }, { "name": "server_certificate", "type": "string", "description": "server_certificate", "optional": true, "enum": [], "example": "example" } ], "body_example": { "key": "example", "base_url": "example", "health_update_info_default_configs": [ { "default_enabled": false, "health_update_info": {} } ], "server_certificate": "example" }, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers_create" ] }, "POST /api/vcenter/registered-tokens": { "verb": "POST", "path": "/api/vcenter/registered-tokens", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "expanded_access_token", "type": "string", "description": "expanded_access_token", "optional": true, "enum": [], "example": "example" } ], "body_example": { "expanded_access_token": "example" }, "operation_ids": [ "Vcenter.RegisteredTokens_create" ] }, "POST /api/vcenter/resource-pool": { "verb": "POST", "path": "/api/vcenter/resource-pool", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "parent", "type": "string", "description": "parent", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "parent": "example" }, "operation_ids": [ "Vcenter.ResourcePool_create" ] }, "POST /api/vcenter/services/{service}": { "verb": "POST", "path": "/api/vcenter/services/{service}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "restart", "start", "stop" ], "example": "restart" } ], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "identifier of the service to restart", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Services.Service_restart", "Vcenter.Services.Service_start", "Vcenter.Services.Service_stop" ] }, "POST /api/vcenter/storage/policies/{policy}": { "verb": "POST", "path": "/api/vcenter/storage/policies/{policy}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-compatibility" ], "example": "check-compatibility" } ], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "The storage policy identifier", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Storage.Policies_checkCompatibility" ] }, "POST /api/vcenter/system": { "verb": "POST", "path": "/api/vcenter/system", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "hello" ], "example": "hello" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.System_hello" ] }, "POST /api/vcenter/system-config/psc-registration": { "verb": "POST", "path": "/api/vcenter/system-config/psc-registration", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "repoint" ], "example": "repoint" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.SystemConfig.PscRegistration_repoint" ] }, "POST /api/vcenter/trusted-infrastructure/attestation/services": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/attestation/services", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "group", "type": "string", "description": "group", "optional": true, "enum": [], "example": "example" }, { "name": "trusted_ca.cert_chain.0", "type": "string", "description": "trusted_ca.cert_chain.0", "optional": true, "enum": [], "example": "example" }, { "name": "trust_authority_cluster", "type": "string", "description": "trust_authority_cluster", "optional": true, "enum": [], "example": "example" }, { "name": "address.hostname", "type": "string", "description": "address.hostname", "optional": true, "enum": [], "example": "example" } ], "body_example": { "group": "example", "trusted_ca": { "cert_chain": [ "example" ] }, "trust_authority_cluster": "example", "address": { "hostname": "example" } }, "operation_ids": [ "Vcenter.TrustedInfrastructure.Attestation.Services_create" ] }, "POST /api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys/{key}": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys/{key}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "unseal" ], "example": "unseal" } ], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "tpm", "type": "string", "optional": false, "description": "the TPM identifier.", "enum": [], "example": "example" }, { "name": "key", "type": "string", "optional": false, "description": "the endorsement key identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.Hosts.Hardware.Tpm.EndorsementKeys_unseal" ] }, "POST /api/vcenter/trusted-infrastructure/kms/services": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/kms/services", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "group", "type": "string", "description": "group", "optional": true, "enum": [], "example": "example" }, { "name": "trusted_ca.cert_chain.0", "type": "string", "description": "trusted_ca.cert_chain.0", "optional": true, "enum": [], "example": "example" }, { "name": "trust_authority_cluster", "type": "string", "description": "trust_authority_cluster", "optional": true, "enum": [], "example": "example" }, { "name": "address.hostname", "type": "string", "description": "address.hostname", "optional": true, "enum": [], "example": "example" } ], "body_example": { "group": "example", "trusted_ca": { "cert_chain": [ "example" ] }, "trust_authority_cluster": "example", "address": { "hostname": "example" } }, "operation_ids": [ "Vcenter.TrustedInfrastructure.Kms.Services_create" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/os/esx/base-images", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "import-from-imgdb" ], "example": "import-from-imgdb" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Os.Esx.BaseImages_importFromImgdb$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/ca-certificates", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.CaCertificates_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/attestation/tpm2/endorsement-keys", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The id of the cluster on which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Attestation.Tpm2.EndorsementKeys_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the Trust Authority Cluster on which the profile is configured.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "principal.type", "type": "string", "description": "principal.type", "optional": true, "enum": [], "example": "example" }, { "name": "principal.id.domain", "type": "string", "description": "principal.id.domain", "optional": true, "enum": [], "example": "example" }, { "name": "principal.id.name", "type": "string", "description": "principal.id.name", "optional": true, "enum": [], "example": "web-01" }, { "name": "issuer_alias", "type": "string", "description": "issuer_alias", "optional": true, "enum": [], "example": "example" }, { "name": "issuer", "type": "string", "description": "issuer", "optional": true, "enum": [], "example": "example" }, { "name": "certificates.0.cert_chain.0", "type": "string", "description": "certificates.0.cert_chain.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "principal": { "type": "example", "id": { "domain": "example", "name": "web-01" } }, "issuer_alias": "example", "issuer": "example", "certificates": [ { "cert_chain": [ "example" ] } ] }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.ConsumerPrincipals_list$Task", "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.ConsumerPrincipals_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "key_server.type", "type": "string", "description": "key_server.type", "optional": true, "enum": [], "example": "example" }, { "name": "key_server.description", "type": "string", "description": "key_server.description", "optional": true, "enum": [], "example": "example" }, { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" }, { "name": "master_key_id", "type": "string", "description": "master_key_id", "optional": true, "enum": [], "example": "example" } ], "body_example": { "key_server": { "type": "example", "description": "example" }, "provider": "example", "master_key_id": "example" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.ClientCertificate_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/client-certificate/csr", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.ClientCertificate.Csr_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-hosts/attestation": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-hosts/attestation", "query_fields": [ { "name": "projection", "type": "string", "optional": true, "description": "The type of the returned summary - brief, normal, or full.", "enum": [], "example": "example" } ], "path_fields": [], "body_fields": [ { "name": "hosts.0", "type": "string", "description": "hosts.0", "optional": true, "enum": [], "example": "host-11" }, { "name": "clusters.0", "type": "string", "description": "clusters.0", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "address.0.hostname", "type": "string", "description": "address.0.hostname", "optional": true, "enum": [], "example": "example" }, { "name": "groups.0", "type": "string", "description": "groups.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "hosts": [ "host-11" ], "clusters": [ "domain-c21" ], "address": [ { "hostname": "example" } ], "groups": [ "example" ] }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityHosts.Attestation_list" ] }, "POST /api/vcenter/trusted-infrastructure/trust-authority-hosts/kms": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trust-authority-hosts/kms", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityHosts.Kms_list" ] }, "POST /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.Services_list", "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.Services_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/attestation/services-applied-config", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Attestation.ServicesAppliedConfig_list$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example" }, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.Services_list", "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.Services_create$Task" ] }, "POST /api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config": { "verb": "POST", "path": "/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "query" ], "example": "query" } ], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The ID of the cluster against which the operation will be executed.", "enum": [], "example": "domain-c21" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustedClusters.Kms.ServicesAppliedConfig_list$Task" ] }, "POST /api/vcenter/vcha/cluster": { "verb": "POST", "path": "/api/vcenter/vcha/cluster", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "deploy", "failover", "get", "undeploy" ], "example": "deploy" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster_deploy$Task", "Vcenter.Vcha.Cluster_failover$Task", "Vcenter.Vcha.Cluster_get", "Vcenter.Vcha.Cluster_undeploy$Task" ] }, "POST /api/vcenter/vcha/cluster/active": { "verb": "POST", "path": "/api/vcenter/vcha/cluster/active", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get" ], "example": "get" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster.Active_get" ] }, "POST /api/vcenter/vcha/cluster/passive": { "verb": "POST", "path": "/api/vcenter/vcha/cluster/passive", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check", "redeploy" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster.Passive_check", "Vcenter.Vcha.Cluster.Passive_redeploy$Task" ] }, "POST /api/vcenter/vcha/cluster/witness": { "verb": "POST", "path": "/api/vcenter/vcha/cluster/witness", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check", "redeploy" ], "example": "check" } ], "path_fields": [], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vcha.Cluster.Witness_check", "Vcenter.Vcha.Cluster.Witness_redeploy$Task" ] }, "POST /api/vcenter/vm": { "verb": "POST", "path": "/api/vcenter/vm", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "guest_os", "type": "string", "description": "guest_os", "optional": true, "enum": [], "example": "OTHER_GUEST_64" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "placement.folder", "type": "string", "description": "placement.folder", "optional": true, "enum": [], "example": "group-v23" }, { "name": "placement.resource_pool", "type": "string", "description": "placement.resource_pool", "optional": true, "enum": [], "example": "resgroup-22" }, { "name": "placement.host", "type": "string", "description": "placement.host", "optional": true, "enum": [], "example": "host-11" }, { "name": "placement.cluster", "type": "string", "description": "placement.cluster", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "placement.datastore", "type": "string", "description": "placement.datastore", "optional": true, "enum": [], "example": "datastore-31" }, { "name": "cpu.count", "type": "integer", "description": "cpu.count", "optional": true, "enum": [], "example": 2 }, { "name": "cpu.cores_per_socket", "type": "integer", "description": "cpu.cores_per_socket", "optional": true, "enum": [], "example": 1 }, { "name": "cpu.hot_add_enabled", "type": "boolean", "description": "cpu.hot_add_enabled", "optional": true, "enum": [], "example": false }, { "name": "cpu.hot_remove_enabled", "type": "boolean", "description": "cpu.hot_remove_enabled", "optional": true, "enum": [], "example": false }, { "name": "memory.size_mib", "type": "integer", "description": "memory.size_mib", "optional": true, "enum": [], "example": 2048 }, { "name": "memory.hot_add_enabled", "type": "boolean", "description": "memory.hot_add_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "guest_os": "OTHER_GUEST_64", "name": "web-01", "placement": { "folder": "group-v23", "resource_pool": "resgroup-22", "host": "host-11", "cluster": "domain-c21", "datastore": "datastore-31" }, "cpu": { "count": 2, "cores_per_socket": 1, "hot_add_enabled": false, "hot_remove_enabled": false }, "memory": { "size_mib": 2048, "hot_add_enabled": false } }, "operation_ids": [ "Vcenter.VM_create" ] }, "POST /api/vcenter/vm-template/library-items": { "verb": "POST", "path": "/api/vcenter/vm-template/library-items", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "library", "type": "string", "description": "library", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "source_vm", "type": "string", "description": "source_vm", "optional": true, "enum": [], "example": "example" }, { "name": "placement.folder", "type": "string", "description": "placement.folder", "optional": true, "enum": [], "example": "group-v23" }, { "name": "placement.resource_pool", "type": "string", "description": "placement.resource_pool", "optional": true, "enum": [], "example": "resgroup-22" }, { "name": "placement.host", "type": "string", "description": "placement.host", "optional": true, "enum": [], "example": "host-11" }, { "name": "placement.cluster", "type": "string", "description": "placement.cluster", "optional": true, "enum": [], "example": "domain-c21" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "library": "example", "name": "web-01", "source_vm": "example", "placement": { "folder": "group-v23", "resource_pool": "resgroup-22", "host": "host-11", "cluster": "domain-c21" }, "description": "example" }, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems_create" ] }, "POST /api/vcenter/vm-template/library-items/{templateLibraryItem}": { "verb": "POST", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "deploy" ], "example": "deploy" } ], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "identifier of the content library item containing the source virtual machine template to be deployed.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems_deploy" ] }, "POST /api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs": { "verb": "POST", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-out" ], "example": "check-out" } ], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the content library item containing the source virtual machine template to be checked out.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.CheckOuts_checkOut" ] }, "POST /api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}": { "verb": "POST", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/check-outs/{vm}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check-in" ], "example": "check-in" } ], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the content library item in which the virtual machine is checked in.", "enum": [], "example": "example" }, { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine to check into the library item.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.CheckOuts_checkIn" ] }, "POST /api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}": { "verb": "POST", "path": "/api/vcenter/vm-template/library-items/{templateLibraryItem}/versions/{version}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "rollback" ], "example": "rollback" } ], "path_fields": [ { "name": "templateLibraryItem", "type": "string", "optional": false, "description": "Identifier of the VM template library item.", "enum": [], "example": "example" }, { "name": "version", "type": "string", "optional": false, "description": "Version of the library item to rollback.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VmTemplate.LibraryItems.Versions_rollback" ] }, "POST /api/vcenter/vm/{vm}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "relocate", "unregister" ], "example": "relocate" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Existing Virtual machine to relocate.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.VM_relocate", "Vcenter.VM_relocate$Task", "Vcenter.VM_unregister" ] }, "POST /api/vcenter/vm/{vm}/console/tickets": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/console/tickets", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example" }, "operation_ids": [ "Vcenter.Vm.Console.Tickets_create" ] }, "POST /api/vcenter/vm/{vm}/data-sets": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/data-sets", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "host", "type": "string", "description": "host", "optional": true, "enum": [], "example": "host-11" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "guest", "type": "string", "description": "guest", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "host": "host-11", "name": "web-01", "guest": "example", "description": "example" }, "operation_ids": [ "Vcenter.Vm.DataSets_create" ] }, "POST /api/vcenter/vm/{vm}/guest/customization": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/customization", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The unique identifier of the virtual machine that needs to be checked.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Customization_check" ] }, "POST /api/vcenter/vm/{vm}/guest/customization-live": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/customization-live", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "run" ], "example": "run" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The unique identifier of the virtual machine that needs to be customized.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.CustomizationLive_run$Task" ] }, "POST /api/vcenter/vm/{vm}/guest/environment": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/environment", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "list" ], "example": "list" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine to perform the operation on.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Environment_list" ] }, "POST /api/vcenter/vm/{vm}/guest/environment/{name}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/environment/{name}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "get" ], "example": "get" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine to perform the operation on.", "enum": [], "example": "vm-101" }, { "name": "name", "type": "string", "optional": false, "description": "The name of the environment variable to be read.", "enum": [], "example": "web-01" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Environment_get" ] }, "POST /api/vcenter/vm/{vm}/guest/filesystem": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/filesystem", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "create" ], "example": "create" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual Machine to perform the operation on.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Filesystem.Transfers_create" ] }, "POST /api/vcenter/vm/{vm}/guest/filesystem/directories": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/filesystem/directories", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "create", "createTemporary", "delete", "move" ], "example": "create" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual Machine to perform the operation on.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Filesystem.Directories_create", "Vcenter.Vm.Guest.Filesystem.Directories_createTemporary", "Vcenter.Vm.Guest.Filesystem.Directories_delete", "Vcenter.Vm.Guest.Filesystem.Directories_move" ] }, "POST /api/vcenter/vm/{vm}/guest/filesystem/files": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/filesystem/files", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "createTemporary", "list", "move", "update" ], "example": "createTemporary" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual Machine to perform the operation on.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Filesystem.Files_createTemporary", "Vcenter.Vm.Guest.Filesystem.Files_list", "Vcenter.Vm.Guest.Filesystem.Files_move", "Vcenter.Vm.Guest.Filesystem.Files_update" ] }, "POST /api/vcenter/vm/{vm}/guest/filesystem/files/{path}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/filesystem/files/{path}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "delete", "get" ], "example": "delete" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual Machine to perform the operation on.", "enum": [], "example": "vm-101" }, { "name": "path", "type": "string", "optional": false, "description": "The complete path to the file or symbolic link to be deleted.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Filesystem.Files_delete", "Vcenter.Vm.Guest.Filesystem.Files_get" ] }, "POST /api/vcenter/vm/{vm}/guest/power": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/power", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "reboot", "shutdown", "standby" ], "example": "reboot" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Power_reboot", "Vcenter.Vm.Guest.Power_shutdown", "Vcenter.Vm.Guest.Power_standby" ] }, "POST /api/vcenter/vm/{vm}/guest/processes": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/processes", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "create", "list" ], "example": "create" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine to perform the operation on.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Processes_create", "Vcenter.Vm.Guest.Processes_list" ] }, "POST /api/vcenter/vm/{vm}/guest/processes/{pid}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/guest/processes/{pid}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "delete", "get" ], "example": "delete" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine to perform the operation on.", "enum": [], "example": "vm-101" }, { "name": "pid", "type": "integer", "optional": false, "description": "Process ID of the process to be terminated", "enum": [], "example": 1 } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Guest.Processes_delete", "Vcenter.Vm.Guest.Processes_get" ] }, "POST /api/vcenter/vm/{vm}/hardware": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "upgrade" ], "example": "upgrade" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware_upgrade" ] }, "POST /api/vcenter/vm/{vm}/hardware/adapter/nvme": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/adapter/nvme", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "bus", "type": "integer", "description": "bus", "optional": true, "enum": [], "example": 1 }, { "name": "pci_slot_number", "type": "integer", "description": "pci_slot_number", "optional": true, "enum": [], "example": 1 } ], "body_example": { "bus": 1, "pci_slot_number": 1 }, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Nvme_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/adapter/sata": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/adapter/sata", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "bus", "type": "integer", "description": "bus", "optional": true, "enum": [], "example": 1 }, { "name": "pci_slot_number", "type": "integer", "description": "pci_slot_number", "optional": true, "enum": [], "example": 1 } ], "body_example": { "type": "example", "bus": 1, "pci_slot_number": 1 }, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Sata_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/adapter/scsi": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/adapter/scsi", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "bus", "type": "integer", "description": "bus", "optional": true, "enum": [], "example": 1 }, { "name": "pci_slot_number", "type": "integer", "description": "pci_slot_number", "optional": true, "enum": [], "example": 1 }, { "name": "sharing", "type": "string", "description": "sharing", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example", "bus": 1, "pci_slot_number": 1, "sharing": "example" }, "operation_ids": [ "Vcenter.Vm.Hardware.Adapter.Scsi_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/cdrom": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/cdrom", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "ide.primary", "type": "boolean", "description": "ide.primary", "optional": true, "enum": [], "example": false }, { "name": "ide.master", "type": "boolean", "description": "ide.master", "optional": true, "enum": [], "example": false }, { "name": "sata.bus", "type": "integer", "description": "sata.bus", "optional": true, "enum": [], "example": 1 }, { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "type": "example", "ide": { "primary": false, "master": false }, "sata": { "bus": 1 }, "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "cdrom", "type": "string", "optional": false, "description": "Virtual CD-ROM device identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Cdrom_connect", "Vcenter.Vm.Hardware.Cdrom_disconnect" ] }, "POST /api/vcenter/vm/{vm}/hardware/disk": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/disk", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "ide.primary", "type": "boolean", "description": "ide.primary", "optional": true, "enum": [], "example": false }, { "name": "ide.master", "type": "boolean", "description": "ide.master", "optional": true, "enum": [], "example": false }, { "name": "scsi.bus", "type": "integer", "description": "scsi.bus", "optional": true, "enum": [], "example": 1 }, { "name": "sata.bus", "type": "integer", "description": "sata.bus", "optional": true, "enum": [], "example": 1 }, { "name": "nvme.bus", "type": "integer", "description": "nvme.bus", "optional": true, "enum": [], "example": 1 }, { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example", "ide": { "primary": false, "master": false }, "scsi": { "bus": 1 }, "sata": { "bus": 1 }, "nvme": { "bus": 1 }, "backing": { "type": "example" } }, "operation_ids": [ "Vcenter.Vm.Hardware.Disk_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/ethernet": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/ethernet", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" }, { "name": "upt_compatibility_enabled", "type": "boolean", "description": "upt_compatibility_enabled", "optional": true, "enum": [], "example": false }, { "name": "upt_v2_compatibility_enabled", "type": "boolean", "description": "upt_v2_compatibility_enabled", "optional": true, "enum": [], "example": false }, { "name": "mac_type", "type": "string", "description": "mac_type", "optional": true, "enum": [], "example": "example" }, { "name": "mac_address", "type": "string", "description": "mac_address", "optional": true, "enum": [], "example": "example" }, { "name": "pci_slot_number", "type": "integer", "description": "pci_slot_number", "optional": true, "enum": [], "example": 1 } ], "body_example": { "type": "example", "upt_compatibility_enabled": false, "upt_v2_compatibility_enabled": false, "mac_type": "example", "mac_address": "example", "pci_slot_number": 1 }, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/ethernet/{nic}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/ethernet/{nic}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "nic", "type": "string", "optional": false, "description": "Virtual Ethernet adapter identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Ethernet_connect", "Vcenter.Vm.Hardware.Ethernet_disconnect" ] }, "POST /api/vcenter/vm/{vm}/hardware/floppy": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/floppy", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/floppy/{floppy}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/floppy/{floppy}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "floppy", "type": "string", "optional": false, "description": "Virtual floppy drive identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Floppy_connect", "Vcenter.Vm.Hardware.Floppy_disconnect" ] }, "POST /api/vcenter/vm/{vm}/hardware/parallel": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/parallel", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/parallel/{port}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/parallel/{port}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual parallel port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Parallel_connect", "Vcenter.Vm.Hardware.Parallel_disconnect" ] }, "POST /api/vcenter/vm/{vm}/hardware/serial": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/serial", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "yield_on_poll", "type": "boolean", "description": "yield_on_poll", "optional": true, "enum": [], "example": false }, { "name": "backing.type", "type": "string", "description": "backing.type", "optional": true, "enum": [], "example": "example" }, { "name": "start_connected", "type": "boolean", "description": "start_connected", "optional": true, "enum": [], "example": false }, { "name": "allow_guest_control", "type": "boolean", "description": "allow_guest_control", "optional": true, "enum": [], "example": false } ], "body_example": { "yield_on_poll": false, "backing": { "type": "example" }, "start_connected": false, "allow_guest_control": false }, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_create" ] }, "POST /api/vcenter/vm/{vm}/hardware/serial/{port}": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/hardware/serial/{port}", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" }, { "name": "port", "type": "string", "optional": false, "description": "Virtual serial port identifier.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Hardware.Serial_connect", "Vcenter.Vm.Hardware.Serial_disconnect" ] }, "POST /api/vcenter/vm/{vm}/power": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/power", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "reset", "start", "stop", "suspend" ], "example": "reset" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Power_reset", "Vcenter.Vm.Power_start", "Vcenter.Vm.Power_stop", "Vcenter.Vm.Power_suspend" ] }, "POST /api/vcenter/vm/{vm}/storage/policy/compliance": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/storage/policy/compliance", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "check" ], "example": "check" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Storage.Policy.Compliance_check" ] }, "POST /api/vcenter/vm/{vm}/tools": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/tools", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "upgrade" ], "example": "upgrade" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Tools_upgrade" ] }, "POST /api/vcenter/vm/{vm}/tools/installer": { "verb": "POST", "path": "/api/vcenter/vm/{vm}/tools/installer", "query_fields": [ { "name": "action", "type": "string", "optional": false, "description": "Operation action query parameter", "enum": [ "connect", "disconnect" ], "example": "connect" } ], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine ID", "enum": [], "example": "vm-101" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.Tools.Installer_connect", "Vcenter.Vm.Tools.Installer_disconnect" ] }, "PUT /api/appliance/access/consolecli": { "verb": "PUT", "path": "/api/appliance/access/consolecli", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "enabled": false }, "operation_ids": [ "Appliance.Access.Consolecli_set" ] }, "PUT /api/appliance/access/dcui": { "verb": "PUT", "path": "/api/appliance/access/dcui", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "enabled": false }, "operation_ids": [ "Appliance.Access.Dcui_set" ] }, "PUT /api/appliance/access/shell": { "verb": "PUT", "path": "/api/appliance/access/shell", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "timeout", "type": "integer", "description": "timeout", "optional": true, "enum": [], "example": 1 }, { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "timeout": 1, "enabled": false }, "operation_ids": [ "Appliance.Access.Shell_set" ] }, "PUT /api/appliance/access/ssh": { "verb": "PUT", "path": "/api/appliance/access/ssh", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "enabled": false }, "operation_ids": [ "Appliance.Access.Ssh_set" ] }, "PUT /api/appliance/local-accounts/global-policy": { "verb": "PUT", "path": "/api/appliance/local-accounts/global-policy", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "max_days", "type": "integer", "description": "max_days", "optional": true, "enum": [], "example": 1 }, { "name": "min_days", "type": "integer", "description": "min_days", "optional": true, "enum": [], "example": 1 }, { "name": "warn_days", "type": "integer", "description": "warn_days", "optional": true, "enum": [], "example": 1 }, { "name": "prior_password_remember_count", "type": "integer", "description": "prior_password_remember_count", "optional": true, "enum": [], "example": 1 }, { "name": "failed_attempt_count_before_account_lockout", "type": "integer", "description": "failed_attempt_count_before_account_lockout", "optional": true, "enum": [], "example": 1 }, { "name": "length_of_lockout_period_in_seconds", "type": "integer", "description": "length_of_lockout_period_in_seconds", "optional": true, "enum": [], "example": 1 } ], "body_example": { "max_days": 1, "min_days": 1, "warn_days": 1, "prior_password_remember_count": 1, "failed_attempt_count_before_account_lockout": 1, "length_of_lockout_period_in_seconds": 1 }, "operation_ids": [ "Appliance.LocalAccounts.Policy_set" ] }, "PUT /api/appliance/local-accounts/{username}": { "verb": "PUT", "path": "/api/appliance/local-accounts/{username}", "query_fields": [], "path_fields": [ { "name": "username", "type": "string", "optional": false, "description": "User login name", "enum": [], "example": "example" } ], "body_fields": [ { "name": "password", "type": "string", "description": "password", "optional": true, "enum": [], "example": "example" }, { "name": "roles.0", "type": "string", "description": "roles.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "password": "example", "roles": [ "example" ] }, "operation_ids": [ "Appliance.LocalAccounts_set" ] }, "PUT /api/appliance/logging/forwarding": { "verb": "PUT", "path": "/api/appliance/logging/forwarding", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cfg_list.0.protocol", "type": "string", "description": "cfg_list.0.protocol", "optional": true, "enum": [], "example": "example" }, { "name": "cfg_list.0.port", "type": "integer", "description": "cfg_list.0.port", "optional": true, "enum": [], "example": 1 }, { "name": "cfg_list.0.hostname", "type": "string", "description": "cfg_list.0.hostname", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cfg_list": [ { "protocol": "example", "port": 1, "hostname": "example" } ] }, "operation_ids": [ "Appliance.Logging.Forwarding_set" ] }, "PUT /api/appliance/logging/liagent/log-collection": { "verb": "PUT", "path": "/api/appliance/logging/liagent/log-collection", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "configurations.0.unittype", "type": "string", "description": "configurations.0.unittype", "optional": true, "enum": [], "example": "example" }, { "name": "configurations.0.unitid", "type": "string", "description": "configurations.0.unitid", "optional": true, "enum": [], "example": "example" }, { "name": "configurations.0.content", "type": "string", "description": "configurations.0.content", "optional": true, "enum": [], "example": "example" }, { "name": "configurations.0.enabled", "type": "boolean", "description": "configurations.0.enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "configurations": [ { "unittype": "example", "unitid": "example", "content": "example", "enabled": false } ] }, "operation_ids": [ "Appliance.Logging.Liagent.LogCollection_set" ] }, "PUT /api/appliance/networking/dns/domains": { "verb": "PUT", "path": "/api/appliance/networking/dns/domains", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "domains.0", "type": "string", "description": "domains.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "domains": [ "example" ] }, "operation_ids": [ "Appliance.Networking.Dns.Domains_set" ] }, "PUT /api/appliance/networking/dns/hostname": { "verb": "PUT", "path": "/api/appliance/networking/dns/hostname", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Appliance.Networking.Dns.Hostname_set" ] }, "PUT /api/appliance/networking/dns/servers": { "verb": "PUT", "path": "/api/appliance/networking/dns/servers", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "servers.0", "type": "string", "description": "servers.0", "optional": true, "enum": [], "example": "example" }, { "name": "mode", "type": "string", "description": "mode", "optional": true, "enum": [], "example": "example" } ], "body_example": { "servers": [ "example" ], "mode": "example" }, "operation_ids": [ "Appliance.Networking.Dns.Servers_set" ] }, "PUT /api/appliance/networking/firewall/inbound": { "verb": "PUT", "path": "/api/appliance/networking/firewall/inbound", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "rules.0.policy", "type": "string", "description": "rules.0.policy", "optional": true, "enum": [], "example": "example" }, { "name": "rules.0.address", "type": "string", "description": "rules.0.address", "optional": true, "enum": [], "example": "example" }, { "name": "rules.0.prefix", "type": "integer", "description": "rules.0.prefix", "optional": true, "enum": [], "example": 1 } ], "body_example": { "rules": [ { "policy": "example", "address": "example", "prefix": 1 } ] }, "operation_ids": [ "Appliance.Networking.Firewall.Inbound_set" ] }, "PUT /api/appliance/networking/interfaces/{interface_name}/ipv4": { "verb": "PUT", "path": "/api/appliance/networking/interfaces/{interface_name}/ipv4", "query_fields": [], "path_fields": [ { "name": "interface_name", "type": "string", "optional": false, "description": "Network interface to update, for example, \"nic0\".", "enum": [], "example": "example" } ], "body_fields": [ { "name": "mode", "type": "string", "description": "mode", "optional": true, "enum": [], "example": "example" } ], "body_example": { "mode": "example" }, "operation_ids": [ "Appliance.Networking.Interfaces.Ipv4_set" ] }, "PUT /api/appliance/networking/interfaces/{interface_name}/ipv6": { "verb": "PUT", "path": "/api/appliance/networking/interfaces/{interface_name}/ipv6", "query_fields": [], "path_fields": [ { "name": "interface_name", "type": "string", "optional": false, "description": "Network interface to update, for example, \"nic0\".", "enum": [], "example": "example" } ], "body_fields": [ { "name": "default_gateway", "type": "string", "description": "default_gateway", "optional": true, "enum": [], "example": "example" }, { "name": "autoconf", "type": "boolean", "description": "autoconf", "optional": true, "enum": [], "example": false }, { "name": "dhcp", "type": "boolean", "description": "dhcp", "optional": true, "enum": [], "example": false }, { "name": "addresses.0.address", "type": "string", "description": "addresses.0.address", "optional": true, "enum": [], "example": "example" }, { "name": "addresses.0.prefix", "type": "integer", "description": "addresses.0.prefix", "optional": true, "enum": [], "example": 1 } ], "body_example": { "default_gateway": "example", "autoconf": false, "dhcp": false, "addresses": [ { "address": "example", "prefix": 1 } ] }, "operation_ids": [ "Appliance.Networking.Interfaces.Ipv6_set" ] }, "PUT /api/appliance/networking/noproxy": { "verb": "PUT", "path": "/api/appliance/networking/noproxy", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "servers.0", "type": "string", "description": "servers.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "servers": [ "example" ] }, "operation_ids": [ "Appliance.Networking.NoProxy_set" ] }, "PUT /api/appliance/networking/proxy/{protocol}": { "verb": "PUT", "path": "/api/appliance/networking/proxy/{protocol}", "query_fields": [], "path_fields": [ { "name": "protocol", "type": "string", "optional": false, "description": "The protocol for which proxy should be set.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "server", "type": "string", "description": "server", "optional": true, "enum": [], "example": "example" }, { "name": "port", "type": "integer", "description": "port", "optional": true, "enum": [], "example": 1 }, { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "server": "example", "port": 1, "enabled": false }, "operation_ids": [ "Appliance.Networking.Proxy_set" ] }, "PUT /api/appliance/ntp": { "verb": "PUT", "path": "/api/appliance/ntp", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "servers.0", "type": "string", "description": "servers.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "servers": [ "example" ] }, "operation_ids": [ "Appliance.Ntp_set" ] }, "PUT /api/appliance/system/global-fips": { "verb": "PUT", "path": "/api/appliance/system/global-fips", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "enabled": false }, "operation_ids": [ "Appliance.System.Security.GlobalFips_update" ] }, "PUT /api/appliance/system/time/timezone": { "verb": "PUT", "path": "/api/appliance/system/time/timezone", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "name": "web-01" }, "operation_ids": [ "Appliance.System.Time.Timezone_set" ] }, "PUT /api/appliance/timesync": { "verb": "PUT", "path": "/api/appliance/timesync", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "mode", "type": "string", "description": "mode", "optional": true, "enum": [], "example": "example" } ], "body_example": { "mode": "example" }, "operation_ids": [ "Appliance.Timesync_set" ] }, "PUT /api/appliance/tls/manual-parameters/global": { "verb": "PUT", "path": "/api/appliance/tls/manual-parameters/global", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "spec.curves.0", "type": "string", "description": "spec.curves.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "spec": { "protocol_versions": [ {} ], "curves": [ "example" ] } }, "operation_ids": [ "Appliance.Tls.ManualParameters.Global_set$Task" ] }, "PUT /api/appliance/tls/manual-parameters/services/{service}": { "verb": "PUT", "path": "/api/appliance/tls/manual-parameters/services/{service}", "query_fields": [], "path_fields": [ { "name": "service", "type": "string", "optional": false, "description": "for which the configured TLS parameters has to be set.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "spec.curves.0", "type": "string", "description": "spec.curves.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "spec": { "protocol_versions": [ {} ], "curves": [ "example" ] } }, "operation_ids": [ "Appliance.Tls.ManualParameters.Services_set$Task" ] }, "PUT /api/appliance/tls/profiles/global": { "verb": "PUT", "path": "/api/appliance/tls/profiles/global", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "profile", "type": "string", "description": "profile", "optional": true, "enum": [], "example": "example" } ], "body_example": { "profile": "example" }, "operation_ids": [ "Appliance.Tls.Profiles.Global_set$Task" ] }, "PUT /api/appliance/update/policy": { "verb": "PUT", "path": "/api/appliance/update/policy", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "check_schedule.0.hour", "type": "integer", "description": "check_schedule.0.hour", "optional": true, "enum": [], "example": 1 }, { "name": "check_schedule.0.minute", "type": "integer", "description": "check_schedule.0.minute", "optional": true, "enum": [], "example": 1 }, { "name": "check_schedule.0.day", "type": "string", "description": "check_schedule.0.day", "optional": true, "enum": [], "example": "example" }, { "name": "auto_stage", "type": "boolean", "description": "auto_stage", "optional": true, "enum": [], "example": false } ], "body_example": { "check_schedule": [ { "hour": 1, "minute": 1, "day": "example" } ], "auto_stage": false }, "operation_ids": [ "Appliance.Update.Policy_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/enablement/software": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/enablement/software", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "skip_software_check", "type": "boolean", "description": "skip_software_check", "optional": true, "enum": [], "example": false } ], "body_example": { "skip_software_check": false }, "operation_ids": [ "Esx.Settings.Clusters.Enablement.Software_enable$Task" ] }, "PUT /api/esx/settings/clusters/{cluster}/policies/apply": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/policies/apply", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "failure_action.action", "type": "string", "description": "failure_action.action", "optional": true, "enum": [], "example": "start" }, { "name": "pre_remediation_power_action", "type": "string", "description": "pre_remediation_power_action", "optional": true, "enum": [], "example": "example" }, { "name": "enable_quick_boot", "type": "boolean", "description": "enable_quick_boot", "optional": true, "enum": [], "example": false }, { "name": "disable_dpm", "type": "boolean", "description": "disable_dpm", "optional": true, "enum": [], "example": false }, { "name": "disable_hac", "type": "boolean", "description": "disable_hac", "optional": true, "enum": [], "example": false }, { "name": "evacuate_offline_vms", "type": "boolean", "description": "evacuate_offline_vms", "optional": true, "enum": [], "example": false } ], "body_example": { "failure_action": { "action": "start" }, "pre_remediation_power_action": "example", "enable_quick_boot": false, "disable_dpm": false, "disable_hac": false, "evacuate_offline_vms": false }, "operation_ids": [ "Esx.Settings.Clusters.Policies.Apply_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/display-name": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.DisplayName_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "name": "web-01" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AddOn_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/display-name": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/display-name", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.DisplayName_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/selection-criteria": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/selection-criteria", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "selection_type", "type": "string", "description": "selection_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "selection_type": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.SelectionCriteria_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/add-on", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "name": "web-01" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.AddOn_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.Components_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The cluster identifier.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "packages": {} }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.HardwareSupport_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/alternative-images/{image}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.AlternativeImages.Software.RemovedComponents_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/base-image", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.BaseImage_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.Components_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/hardware-support", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "packages": {} }, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.HardwareSupport_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Clusters.Software.Drafts.Software.RemovedComponents_set" ] }, "PUT /api/esx/settings/clusters/{cluster}/software/solutions/{solution}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "components.0.component", "type": "string", "description": "components.0.component", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example", "components": [ { "component": "example" } ] }, "operation_ids": [ "Esx.Settings.Clusters.Software.Solutions_set$Task" ] }, "PUT /api/esx/settings/clusters/{cluster}/vms/solutions/{solution}": { "verb": "PUT", "path": "/api/esx/settings/clusters/{cluster}/vms/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "vm_name_template.suffix", "type": "string", "description": "vm_name_template.suffix", "optional": true, "enum": [], "example": "example" }, { "name": "vm_name_template.prefix", "type": "string", "description": "vm_name_template.prefix", "optional": true, "enum": [], "example": "example" }, { "name": "vm_storage_policy", "type": "string", "description": "vm_storage_policy", "optional": true, "enum": [], "example": "example" }, { "name": "display_version", "type": "string", "description": "display_version", "optional": true, "enum": [], "example": "example" }, { "name": "deployment_type", "type": "string", "description": "deployment_type", "optional": true, "enum": [], "example": "example" }, { "name": "ovf_resource.location_type", "type": "string", "description": "ovf_resource.location_type", "optional": true, "enum": [], "example": "example" }, { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "vm_name_template": { "suffix": "example", "prefix": "example" }, "vm_storage_policy": "example", "display_version": "example", "deployment_type": "example", "ovf_resource": { "location_type": "example" }, "display_name": "example" }, "operation_ids": [ "Esx.Settings.Clusters.Vms.Solutions_set$Task" ] }, "PUT /api/esx/settings/defaults/clusters/policies/apply": { "verb": "PUT", "path": "/api/esx/settings/defaults/clusters/policies/apply", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "failure_action.action", "type": "string", "description": "failure_action.action", "optional": true, "enum": [], "example": "start" }, { "name": "pre_remediation_power_action", "type": "string", "description": "pre_remediation_power_action", "optional": true, "enum": [], "example": "example" }, { "name": "enable_quick_boot", "type": "boolean", "description": "enable_quick_boot", "optional": true, "enum": [], "example": false }, { "name": "disable_dpm", "type": "boolean", "description": "disable_dpm", "optional": true, "enum": [], "example": false }, { "name": "disable_hac", "type": "boolean", "description": "disable_hac", "optional": true, "enum": [], "example": false }, { "name": "evacuate_offline_vms", "type": "boolean", "description": "evacuate_offline_vms", "optional": true, "enum": [], "example": false } ], "body_example": { "failure_action": { "action": "start" }, "pre_remediation_power_action": "example", "enable_quick_boot": false, "disable_dpm": false, "disable_hac": false, "evacuate_offline_vms": false }, "operation_ids": [ "Esx.Settings.Defaults.Clusters.Policies.Apply_set" ] }, "PUT /api/esx/settings/defaults/hosts/policies/apply": { "verb": "PUT", "path": "/api/esx/settings/defaults/hosts/policies/apply", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "failure_action.action", "type": "string", "description": "failure_action.action", "optional": true, "enum": [], "example": "start" }, { "name": "pre_remediation_power_action", "type": "string", "description": "pre_remediation_power_action", "optional": true, "enum": [], "example": "example" }, { "name": "enable_quick_boot", "type": "boolean", "description": "enable_quick_boot", "optional": true, "enum": [], "example": false }, { "name": "software_policy_spec.skip_reserved_vibs_caching", "type": "boolean", "description": "software_policy_spec.skip_reserved_vibs_caching", "optional": true, "enum": [], "example": false } ], "body_example": { "failure_action": { "action": "start" }, "pre_remediation_power_action": "example", "enable_quick_boot": false, "software_policy_spec": { "skip_reserved_vibs_caching": false } }, "operation_ids": [ "Esx.Settings.Defaults.Hosts.Policies.Apply_set" ] }, "PUT /api/esx/settings/depots/sync-schedule": { "verb": "PUT", "path": "/api/esx/settings/depots/sync-schedule", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "email_addresses.0", "type": "string", "description": "email_addresses.0", "optional": true, "enum": [], "example": "example" }, { "name": "enabled", "type": "boolean", "description": "enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "email_addresses": [ "example" ], "enabled": false }, "operation_ids": [ "Esx.Settings.Depots.SyncSchedule_set" ] }, "PUT /api/esx/settings/depots/umds": { "verb": "PUT", "path": "/api/esx/settings/depots/umds", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "location", "type": "string", "description": "location", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "location": "example", "description": "example" }, "operation_ids": [ "Esx.Settings.Depots.Umds_set" ] }, "PUT /api/esx/settings/hosts/{host}/enablement/software": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/enablement/software", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" } ], "body_fields": [ { "name": "skip_software_check", "type": "boolean", "description": "skip_software_check", "optional": true, "enum": [], "example": false } ], "body_example": { "skip_software_check": false }, "operation_ids": [ "Esx.Settings.Hosts.Enablement.Software_enable$Task" ] }, "PUT /api/esx/settings/hosts/{host}/policies/apply": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/policies/apply", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "The host identifier.", "enum": [], "example": "host-11" } ], "body_fields": [ { "name": "failure_action.action", "type": "string", "description": "failure_action.action", "optional": true, "enum": [], "example": "start" }, { "name": "pre_remediation_power_action", "type": "string", "description": "pre_remediation_power_action", "optional": true, "enum": [], "example": "example" }, { "name": "enable_quick_boot", "type": "boolean", "description": "enable_quick_boot", "optional": true, "enum": [], "example": false }, { "name": "software_policy_spec.skip_reserved_vibs_caching", "type": "boolean", "description": "software_policy_spec.skip_reserved_vibs_caching", "optional": true, "enum": [], "example": false } ], "body_example": { "failure_action": { "action": "start" }, "pre_remediation_power_action": "example", "enable_quick_boot": false, "software_policy_spec": { "skip_reserved_vibs_caching": false } }, "operation_ids": [ "Esx.Settings.Hosts.Policies.Apply_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/drafts/{draft}/display-name": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.DisplayName_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/add-on", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "name": "web-01" }, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.AddOn_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/base-image", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example" }, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.BaseImage_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.Components_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/drafts/{draft}/software/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the standalone host.", "enum": [], "example": "host-11" }, { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Hosts.Software.Drafts.Software.RemovedComponents_set" ] }, "PUT /api/esx/settings/hosts/{host}/software/solutions/{solution}": { "verb": "PUT", "path": "/api/esx/settings/hosts/{host}/software/solutions/{solution}", "query_fields": [], "path_fields": [ { "name": "host", "type": "string", "optional": false, "description": "Identifier of the host.", "enum": [], "example": "host-11" }, { "name": "solution", "type": "string", "optional": false, "description": "Identifier of the solution.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "components.0.component", "type": "string", "description": "components.0.component", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example", "components": [ { "component": "example" } ] }, "operation_ids": [ "Esx.Settings.Hosts.Software.Solutions_set$Task" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/add-on": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "name": "web-01" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AddOn_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/add-on", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "name": "web-01" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.AddOn_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.Components_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/display-name": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/display-name", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.DisplayName_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "packages": {} }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.HardwareSupport_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.RemovedComponents_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/selection-criteria": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/alternative-images/{image}/selection-criteria", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the draft.", "enum": [], "example": "example" }, { "name": "image", "type": "string", "optional": false, "description": "Identifier of the alternative image.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "selection_type", "type": "string", "description": "selection_type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "selection_type": "example" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.AlternativeImages.SelectionCriteria_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/base-image": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/base-image", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.BaseImage_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/components/{component}": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.Components_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/display-name": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/display-name", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the software specification draft.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" } ], "body_example": { "display_name": "example" }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.DisplayName_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/hardware-support": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/hardware-support", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of image working copy document being updated", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "packages": {} }, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.HardwareSupport_set" ] }, "PUT /api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}": { "verb": "PUT", "path": "/api/esx/settings/repository/software/drafts/{draft}/removed-components/{component}", "query_fields": [], "path_fields": [ { "name": "draft", "type": "string", "optional": false, "description": "Identifier of the working copy document.", "enum": [], "example": "example" }, { "name": "component", "type": "string", "optional": false, "description": "Identifier of the component.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Esx.Settings.Repository.Software.Drafts.RemovedComponents_set" ] }, "PUT /api/vcenter/certificate-management/vcenter/signing-certificate": { "verb": "PUT", "path": "/api/vcenter/certificate-management/vcenter/signing-certificate", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "private_key", "type": "string", "description": "private_key", "optional": true, "enum": [], "example": "example" }, { "name": "signing_cert_chain.cert_chain.0", "type": "string", "description": "signing_cert_chain.cert_chain.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "private_key": "example", "signing_cert_chain": { "cert_chain": [ "example" ] } }, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.SigningCertificate_set" ] }, "PUT /api/vcenter/certificate-management/vcenter/tls": { "verb": "PUT", "path": "/api/vcenter/certificate-management/vcenter/tls", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "cert", "type": "string", "description": "cert", "optional": true, "enum": [], "example": "example" } ], "body_example": { "cert": "example" }, "operation_ids": [ "Vcenter.CertificateManagement.Vcenter.Tls_set" ] }, "PUT /api/vcenter/cluster/{cluster}/evc-mode": { "verb": "PUT", "path": "/api/vcenter/cluster/{cluster}/evc-mode", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "The identifier of the cluster.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "evc_mode.key", "type": "string", "description": "evc_mode.key", "optional": true, "enum": [], "example": "example" } ], "body_example": { "evc_mode": { "key": "example", "masks": [ {} ] } }, "operation_ids": [ "Vcenter.Cluster.EvcMode_set$Task" ] }, "PUT /api/vcenter/guest/customization-specs/{name}": { "verb": "PUT", "path": "/api/vcenter/guest/customization-specs/{name}", "query_fields": [], "path_fields": [ { "name": "name", "type": "string", "optional": false, "description": "The name of the customization specification that needs to be set.", "enum": [], "example": "web-01" } ], "body_fields": [ { "name": "fingerprint", "type": "string", "description": "fingerprint", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "spec.global_dns_settings.dns_suffix_list.0", "type": "string", "description": "spec.global_dns_settings.dns_suffix_list.0", "optional": true, "enum": [], "example": "example" }, { "name": "spec.global_dns_settings.dns_servers.0", "type": "string", "description": "spec.global_dns_settings.dns_servers.0", "optional": true, "enum": [], "example": "example" }, { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "fingerprint": "example", "name": "web-01", "spec": { "configuration_spec": { "windows_config": {}, "linux_config": {}, "cloud_config": {} }, "global_dns_settings": { "dns_suffix_list": [ "example" ], "dns_servers": [ "example" ] }, "interfaces": [ {} ] }, "description": "example" }, "operation_ids": [ "Vcenter.Guest.CustomizationSpecs_set" ] }, "PUT /api/vcenter/lcm/deployment/migration-upgrade": { "verb": "PUT", "path": "/api/vcenter/lcm/deployment/migration-upgrade", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" }, { "name": "deployment.appliance.root_password", "type": "string", "description": "deployment.appliance.root_password", "optional": true, "enum": [], "example": "example" }, { "name": "deployment.appliance.name", "type": "string", "description": "deployment.appliance.name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "version": "example", "deployment": { "appliance": { "root_password": "example", "name": "web-01" } } }, "operation_ids": [ "Vcenter.Lcm.Deployment.MigrationUpgrade_set" ] }, "PUT /api/vcenter/lcm/deployment/repository": { "verb": "PUT", "path": "/api/vcenter/lcm/deployment/repository", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "address", "type": "string", "description": "address", "optional": true, "enum": [], "example": "example" } ], "body_example": { "address": "example" }, "operation_ids": [ "Vcenter.Lcm.Deployment.Repository_set" ] }, "PUT /api/vcenter/lcm/depot/services": { "verb": "PUT", "path": "/api/vcenter/lcm/depot/services", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "services.0.key", "type": "string", "description": "services.0.key", "optional": true, "enum": [], "example": "example" }, { "name": "services.0.type", "type": "string", "description": "services.0.type", "optional": true, "enum": [], "example": "example" }, { "name": "services.0.name", "type": "string", "description": "services.0.name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "services": [ { "key": "example", "type": "example", "name": "web-01", "nodes": [ {} ] } ] }, "operation_ids": [ "Vcenter.Lcm.Depot.Services_set" ] }, "PUT /api/vcenter/lcm/interop/bundle": { "verb": "PUT", "path": "/api/vcenter/lcm/interop/bundle", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "data", "type": "string", "description": "data", "optional": true, "enum": [], "example": "example" } ], "body_example": { "data": "example" }, "operation_ids": [ "Vcenter.Lcm.Interop.InteropBundle_set$Task" ] }, "PUT /api/vcenter/namespace-management/clusters/{cluster}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/clusters/{cluster}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster on which vSphere Namespaces is enabled.", "enum": [], "example": "domain-c21" } ], "body_fields": [ { "name": "size_hint", "type": "string", "description": "size_hint", "optional": true, "enum": [], "example": "example" }, { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" }, { "name": "ephemeral_storage_policy", "type": "string", "description": "ephemeral_storage_policy", "optional": true, "enum": [], "example": "example" }, { "name": "image_storage.storage_policy", "type": "string", "description": "image_storage.storage_policy", "optional": true, "enum": [], "example": "example" }, { "name": "master_storage_policy", "type": "string", "description": "master_storage_policy", "optional": true, "enum": [], "example": "example" } ], "body_example": { "size_hint": "example", "network_provider": "example", "ephemeral_storage_policy": "example", "image_storage": { "storage_policy": "example" }, "master_storage_policy": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Clusters_set" ] }, "PUT /api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/clusters/{cluster}/load-balancers/{id}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster the load balancer is associated with.", "enum": [], "example": "domain-c21" }, { "name": "id", "type": "string", "optional": false, "description": "Identifier of the load balancer.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "provider", "type": "string", "description": "provider", "optional": true, "enum": [], "example": "example" }, { "name": "address_ranges.0.count", "type": "integer", "description": "address_ranges.0.count", "optional": true, "enum": [], "example": 2 }, { "name": "address_ranges.0.address", "type": "string", "description": "address_ranges.0.address", "optional": true, "enum": [], "example": "example" } ], "body_example": { "provider": "example", "address_ranges": [ { "count": 2, "address": "example" } ] }, "operation_ids": [ "Vcenter.NamespaceManagement.LoadBalancers_set" ] }, "PUT /api/vcenter/namespace-management/clusters/{cluster}/networks/{network}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/clusters/{cluster}/networks/{network}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster.", "enum": [], "example": "domain-c21" }, { "name": "network", "type": "string", "optional": false, "description": "Identifier for the vSphere Namespaces network.", "enum": [], "example": "network-41" } ], "body_fields": [ { "name": "network_provider", "type": "string", "description": "network_provider", "optional": true, "enum": [], "example": "example" } ], "body_example": { "network_provider": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Networks_set" ] }, "PUT /api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier for the cluster backing this Supervisor.", "enum": [], "example": "domain-c21" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.SupervisorServices.ClusterSupervisorServices_set" ] }, "PUT /api/vcenter/namespace-management/infrastructure-policies/{policy}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/infrastructure-policies/{policy}", "query_fields": [], "path_fields": [ { "name": "policy", "type": "string", "optional": false, "description": "Identifier for the policy to update.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.InfrastructurePolicies_set" ] }, "PUT /api/vcenter/namespace-management/lifecycle/content/libraries": { "verb": "PUT", "path": "/api/vcenter/namespace-management/lifecycle/content/libraries", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "library", "type": "string", "description": "library", "optional": true, "enum": [], "example": "example" } ], "body_example": { "library": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Lifecycle.Content.Libraries_set" ] }, "PUT /api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/identity/providers/{provider}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "the identifier for the Supervisor associated with the identity provider to be updated.", "enum": [], "example": "example" }, { "name": "provider", "type": "string", "optional": false, "description": "the identifier for the identity provider that is to be updated.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "client_id", "type": "string", "description": "client_id", "optional": true, "enum": [], "example": "example" }, { "name": "display_name", "type": "string", "description": "display_name", "optional": true, "enum": [], "example": "example" }, { "name": "issuer_url", "type": "string", "description": "issuer_url", "optional": true, "enum": [], "example": "example" }, { "name": "client_secret", "type": "string", "description": "client_secret", "optional": true, "enum": [], "example": "example" } ], "body_example": { "client_id": "example", "display_name": "example", "issuer_url": "example", "client_secret": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Identity.Providers_set" ] }, "PUT /api/vcenter/namespace-management/supervisors/{supervisor}/logs/agent-configuration": { "verb": "PUT", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/logs/agent-configuration", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier of the Supervisor to which the log streaming configuration is being set.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "configurations.0.unittype", "type": "string", "description": "configurations.0.unittype", "optional": true, "enum": [], "example": "example" }, { "name": "configurations.0.content", "type": "string", "description": "configurations.0.content", "optional": true, "enum": [], "example": "example" }, { "name": "configurations.0.enabled", "type": "boolean", "description": "configurations.0.enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "configurations": [ { "unittype": "example", "content": "example", "enabled": false } ] }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Logs.AgentConfiguration_set" ] }, "PUT /api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/metrics/remote-endpoints/{remoteEndpoint}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "identifier for the Supervisor for which the remote endpoint is being modified.", "enum": [], "example": "example" }, { "name": "remoteEndpoint", "type": "string", "optional": false, "description": "identifier for the remote endpoint that is being modified.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "remote_endpoint_type", "type": "string", "description": "remote_endpoint_type", "optional": true, "enum": [], "example": "example" }, { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" } ], "body_example": { "remote_endpoint_type": "example", "name": "web-01" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Metrics.RemoteEndpoints_set" ] }, "PUT /api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}": { "verb": "PUT", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/supervisor-services/{supervisorService}", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor.", "enum": [], "example": "example" }, { "name": "supervisorService", "type": "string", "optional": false, "description": "Identifier for the Supervisor Service.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "version", "type": "string", "description": "version", "optional": true, "enum": [], "example": "example" } ], "body_example": { "version": "example" }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.SupervisorServices_set" ] }, "PUT /api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings": { "verb": "PUT", "path": "/api/vcenter/namespace-management/supervisors/{supervisor}/zones/{zone}/bindings", "query_fields": [], "path_fields": [ { "name": "supervisor", "type": "string", "optional": false, "description": "Identifier for the Supervisor", "enum": [], "example": "example" }, { "name": "zone", "type": "string", "optional": false, "description": "The ID of the vSphere Zone.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": { "resource_allocation": { "vm_reservations": [ {} ] } }, "operation_ids": [ "Vcenter.NamespaceManagement.Supervisors.Zones.Bindings_set" ] }, "PUT /api/vcenter/namespaces/instances/{namespace}": { "verb": "PUT", "path": "/api/vcenter/namespaces/instances/{namespace}", "query_fields": [], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "description", "type": "string", "description": "description", "optional": true, "enum": [], "example": "example" } ], "body_example": { "description": "example" }, "operation_ids": [ "Vcenter.Namespaces.Instances_set" ] }, "PUT /api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}": { "verb": "PUT", "path": "/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}", "query_fields": [ { "name": "type", "type": "string", "optional": false, "description": "The type of subject (USER or GROUP).", "enum": [], "example": "example" } ], "path_fields": [ { "name": "namespace", "type": "string", "optional": false, "description": "Identifier for the namespace.", "enum": [], "example": "example" }, { "name": "domain", "type": "string", "optional": false, "description": "The domain of the subject.", "enum": [], "example": "example" }, { "name": "subject", "type": "string", "optional": false, "description": "The principal for this operation.", "enum": [], "example": "example" } ], "body_fields": [ { "name": "role", "type": "string", "description": "role", "optional": true, "enum": [], "example": "example" } ], "body_example": { "role": "example" }, "operation_ids": [ "Vcenter.Namespaces.Access_set" ] }, "PUT /api/vcenter/phm/hardware-support-managers/{key}": { "verb": "PUT", "path": "/api/vcenter/phm/hardware-support-managers/{key}", "query_fields": [], "path_fields": [ { "name": "key", "type": "string", "optional": false, "description": "HSM key for the HSM to be set", "enum": [], "example": "example" } ], "body_fields": [ { "name": "server_certificate", "type": "string", "description": "server_certificate", "optional": true, "enum": [], "example": "example" }, { "name": "base_url", "type": "string", "description": "base_url", "optional": true, "enum": [], "example": "example" }, { "name": "health_update_info_default_configs.0.default_enabled", "type": "boolean", "description": "health_update_info_default_configs.0.default_enabled", "optional": true, "enum": [], "example": false } ], "body_example": { "server_certificate": "example", "base_url": "example", "health_update_info_default_configs": [ { "default_enabled": false, "health_update_info": {} } ] }, "operation_ids": [ "Vcenter.Phm.HardwareSupportManagers_set" ] }, "PUT /api/vcenter/system-config/deployment-type": { "verb": "PUT", "path": "/api/vcenter/system-config/deployment-type", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "type", "type": "string", "description": "type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "type": "example" }, "operation_ids": [ "Vcenter.SystemConfig.DeploymentType_reconfigure" ] }, "PUT /api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/credential": { "verb": "PUT", "path": "/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/kms/providers/{provider}/credential", "query_fields": [], "path_fields": [ { "name": "cluster", "type": "string", "optional": false, "description": "Identifier of the cluster.", "enum": [], "example": "domain-c21" }, { "name": "provider", "type": "string", "optional": false, "description": "Identifier of the provider.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.TrustedInfrastructure.TrustAuthorityClusters.Kms.Providers.Credential_set$Task" ] }, "PUT /api/vcenter/vcha/cluster/mode": { "verb": "PUT", "path": "/api/vcenter/vcha/cluster/mode", "query_fields": [], "path_fields": [], "body_fields": [ { "name": "mode", "type": "string", "description": "mode", "optional": true, "enum": [], "example": "example" } ], "body_example": { "mode": "example" }, "operation_ids": [ "Vcenter.Vcha.Cluster.Mode_set$Task" ] }, "PUT /api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}": { "verb": "PUT", "path": "/api/vcenter/vm/{vm}/data-sets/{dataSet}/entries/{key}", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Identifier of the virtual machine.", "enum": [], "example": "vm-101" }, { "name": "dataSet", "type": "string", "optional": false, "description": "Identifier of the data set.", "enum": [], "example": "example" }, { "name": "key", "type": "string", "optional": false, "description": "The key of the entry to set. A key can be at most 4096 bytes.", "enum": [], "example": "example" } ], "body_fields": [], "body_example": {}, "operation_ids": [ "Vcenter.Vm.DataSets.Entries_set" ] }, "PUT /api/vcenter/vm/{vm}/evc-mode": { "verb": "PUT", "path": "/api/vcenter/vm/{vm}/evc-mode", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The identifier for the VM.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "evc_mode.key", "type": "string", "description": "evc_mode.key", "optional": true, "enum": [], "example": "example" } ], "body_example": { "evc_mode": { "key": "example", "masks": [ {} ] } }, "operation_ids": [ "Vcenter.Vm.EvcMode_set$Task" ] }, "PUT /api/vcenter/vm/{vm}/guest/customization": { "verb": "PUT", "path": "/api/vcenter/vm/{vm}/guest/customization", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "The unique identifier of the virtual machine that needs to be customized.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "name", "type": "string", "description": "name", "optional": true, "enum": [], "example": "web-01" }, { "name": "spec.global_dns_settings.dns_suffix_list.0", "type": "string", "description": "spec.global_dns_settings.dns_suffix_list.0", "optional": true, "enum": [], "example": "example" }, { "name": "spec.global_dns_settings.dns_servers.0", "type": "string", "description": "spec.global_dns_settings.dns_servers.0", "optional": true, "enum": [], "example": "example" } ], "body_example": { "name": "web-01", "spec": { "configuration_spec": { "windows_config": {}, "linux_config": {}, "cloud_config": {} }, "global_dns_settings": { "dns_suffix_list": [ "example" ], "dns_servers": [ "example" ] }, "interfaces": [ {} ] } }, "operation_ids": [ "Vcenter.Vm.Guest.Customization_set" ] }, "PUT /api/vcenter/vm/{vm}/hardware/boot/device": { "verb": "PUT", "path": "/api/vcenter/vm/{vm}/hardware/boot/device", "query_fields": [], "path_fields": [ { "name": "vm", "type": "string", "optional": false, "description": "Virtual machine identifier.", "enum": [], "example": "vm-101" } ], "body_fields": [ { "name": "devices.0.type", "type": "string", "description": "devices.0.type", "optional": true, "enum": [], "example": "example" } ], "body_example": { "devices": [ { "type": "example" } ] }, "operation_ids": [ "Vcenter.Vm.Hardware.Boot.Device_set" ] } } }