[{"label":"Latest (v37.2)","version":"latest"},{"version":"v37.1"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

VMware Cloud Director OpenAPI Operations Index

All available VMware Cloud Director OpenAPI Operations.


Access Controls

post Create Entity Access Control Grant
Creates an access-control grant
get Get Entity Access Control Grant
Get the specified access-control grant.
get Query Entity Access Control Grants
Get the access-control list for the specified vCD entity.
delete Remove Entity Access Control Grant
Removes the specified access-control grant from the vCD entities access-control list.
put Update Entity Access Control Grant
Updates the specified access-control grant.

Access Levels

get Get Access Level
Get the specified access level.
get Query Access Levels
Get all access levels.

Advisory

post Create Advisory Definition
Create a new advisory definition.
delete Delete Advisory Definition
Delete the advisory with the associated specified id.
get Get Advisory
Get the advisory with the specified id.
get Get Advisory Definition
Get the advisory definition with the specified id.
get Query Advisories
Get a list of all advisories accessible to the user.
get Query Advisory Definitions
Get a list of all advisory definitions.
put Update Advisory
Updates an advisory.

Application Port Profile

delete Delete Application Port Profile
Deletes a specific user-defined Application Port Profile
get Get Application Port Profile
Retrieves a specific user-defined Application Port Profile
put Update Application Port Profile
Updates a specific user-defined Application Port Profile

Application Port Profiles

post Create Application Port Profile
Create a user-defined application port profile.
get Get Application Port Profiles
Get all Application Port Profiles.
post Sync Application Port Profiles
Sync the application port profiles from the network provider to VCD.

Audit Trail

get Query Audit Trail
Get list of audit trail events

Branding

post Create Branding Theme
Create a new custom theme
delete Delete Branding Theme
Delete an existing custom theme
delete Delete Branding Theme Contents
Delete an existing custom theme's contents
delete Delete System Icon
Delete system level icon
delete Delete System Logo
Delete system level logo
delete Delete Tenant Icon
Delete system level icon
delete Delete Tenant Logo
Delete the org-specific logo
get Get Branding Theme
Retrieve a specified theme identified by name
get Get Branding Theme Css
Retrieve the custom CSS for this theme, if any
get Get Branding Themes
Get a list of themes
get Get System Branding
Gets the system level branding
get Get System Icon
Gets the system level browser icon
get Get System Logo
Gets the system level logo
get Get Tenant Branding
Gets org-specific branding
get Get Tenant Icon
Gets the system level browser icon
get Get Tenant Logo
Gets the org-specific logo
put Put System Branding
Sets default branding
put Put System Icon
Sets the system level icon
put Put System Logo
Sets the system level logo
put Put Tenant Branding
Sets org-specific branding
put Put Tenant Icon
Sets the system level icon
put Put Tenant Logo
Sets the org-specific logo
delete Remove Tenant Branding
Remove org-specific branding
put Update Branding Theme
Update an existing custom theme
post Upload Branding Theme Contents
Upload the contents for this theme

Branding Theme

post Convert Old Themes
Initiates converting for the old branding api themes
post Create Branding Theme
Creates a new branding theme
post Create Branding Theme Assignment
Set active theme for an organization
put Create Branding Theme Assignments
Set active theme for a list of organizations
delete Delete Branding Theme
Deletes existing branding theme.
delete Delete Branding Theme Assignment
Remove active branding theme of tenant.
get Get Active Background Theme Resource
Gets the background resource for the active theme for the current organization.
get Get Active Css Theme Resource
Gets the CSS resource for the active theme for the current organization.
get Get Active Custom Links Theme Resource
Gets the custom links for the active theme for the current organization.
get Get Active Fav Icon Theme Resource
Gets the favIcon resource for the active theme for the current organization.
get Get Active Logo Theme Resource
Gets the logo resource for the active theme for the current organization.
get Get Active Portal Name Theme Resource
Gets the portal name for the active theme for the current organization.
get Get Branding Theme
Gets an existing branding theme
get Get Branding Theme Assignments
Gets organizations using this branding theme as active
get Get Branding Themes
Gets the list of all available branding themes
get Get Branding Themes Assignments
Get organizations and their active themes
get Get Theme Zip
Gets theme resources as a zip archive.
put Update Branding Theme
Updates existing branding theme
put Upload Branding Resource
Sets resources for a theme

CORS

get Query Allowed Origins
Queries CORS allowed origins.
put Set Allowed Origins
Sets allowed origins to the given set of origins.

Capabilities

get Get Org VDC Storage Policy Capabilities
Retrieves capabilities of a specific organization VDC storage policy.
get Get Pvdc Storage Policy Capabilities
Retrieves capabilities of a specific provider VDC storage policy.
get Get Quota Policy Capabilities
Retrieves capabilities for quotaPolicy feature.
get Get VDC Capabilities
Retrieves capabilities for the given Organization vDC.
get Get VDC Group Capabilities
Retrieves the supported capabilities of the specified vDC Group.

Cell

delete Delete Cell
Deletes a specified cell.
get Get Cell
Get cell.
get Get Cell Group Current Topology Status
get Get Cell Group Topology Status
get Get Cell Topology History
get Query Cells
Get cells.

Certificate Library

post Add Certificate Library Item
Add an item to the certificate library
post Add Consumer Ref To Cert Library Item
Adds the specified consumer reference to a library item.
delete Delete Certificate Library Item
Remove certificate library item.
get Get Certificate Library Item
Get the specified certificate library item
get Query Cert Library Item Consumer Refs
Gets a paged list of consumers (as references) of a particular certificate library item
get Query Certificate Library
Get the certificate library items
put Replace Cert Library Item Consumer Refs
Replaces the existing consumer refs with the used by references supplied.
put Update Certificate Library Item
Update the specified certificate library item.

Cloud API Base

get Get Base Links
Get base navigation links

Codegen Placeholder

get Get Query Result
This endpoint will not produce results. It is a placeholder to enforce code generation of Page.

Configurations

get Get Config
Get the current setting for the specified configuration property.
get Get Configs
Returns all configuration properties. At present this will always return an EMPTY list.
put Set Config
Sets a configuration property to the provided value.

Cross VDC Network

delete Delete Cross VDC Network
Deletes a specific Cross vDC network
get Get Cross VDC Network
Retrieves a specific Cross vDC network.
post Sync Cross VDC Network
Sync/repair a specific Cross vDC network.
put Update Cross VDC Network
Updates a specific Cross vDC network.

Cross VDC Networks

post Create Cross VDC Network
Creates a Cross vDC network.
get Get All Cross VDC Networks
Get all Cross vDC networks in the system.
get Get All Cross VDC Networks For VDC Group
Get all Cross vDC networks of a vDC group.

Custom Entities

post Create Custom Entity Type
Creates a new custom entity type
post Create Custom Entity Type Action
Creates a new custom entity type action.
delete Delete Custom Entity Type
Delete specified custom entity type.
delete Delete Custom Entity Type Action
Delete specified custom entity type action
get Get Custom Entities
Get list of all custom entities
get Get Custom Entity
Get specified custom entity
get Get Custom Entity As Sdk Object
Get specified custom entity represented as on Sdk-Object
get Get Custom Entity Type
Get specified custom entity type
get Get Custom Entity Type Actions
Get all actions associated with this custom entity type
get Get Custom Entity Type Tenants
Retrieves list of tenants for whom the custom entity type is explicitly published
get Get Custom Entity Type Tenants Query
Retrieves list of tenants for whom the custom entity type is explicitly published
post Post Custom Entity Type Publish
Publishes the custom entity type to the specified tenants
post Post Custom Entity Type Publish All
Publishes the custom entity type to all tenants
post Post Custom Entity Type Publish All Bounded
Publishes the custom entity type to all tenants
post Post Custom Entity Type Publish Bounded
Publishes the custom entity type to the specified tenants
post Post Custom Entity Type Unpublish
Revokes publication of the custom entity type to the specified tenants
post Post Custom Entity Type Unpublish All
Unpublishes the custom entity type from all tenants
post Post Custom Entity Type Unpublish All Bounded
Unpublishes the custom entity type from all tenants
post Post Custom Entity Type Unpublish Bounded
Revokes publication of the custom entity type to the specified tenants
get Query Custom Entity Types
Get list of all custom entity types
put Set Custom Entity Type Tenants
Resets list of tenants for whom the custom entity type is explicitly published
put Set Custom Entity Type Tenants Bounded
Resets list of tenants for whom the custom entity type is explicitly published
put Update Custom Entity Type
Update specified custom entity type

DFW Policies

get Get DFW Policies
Retrieves DFW security policies configuration.
put Update DFW Policies
Update DFW security policies configuration.

DFW Policy

delete Delete DFW Policy
Deletes a specific DFW security policy. Removing a security policy will result in removal of the policy and all of its associated firewall rules.
delete Delete DFW Rule
Deletes a specific firewall rule for a given DFW security policy.
get Get DFW Policy
Retrieves a specific DFW security policy.
get Get DFW Rule
Retrieves a specific firewall rule for a given DFW security policy.
get Get DFW Rules
Retrieves all firewall rules for a given DFW security policy.
put Update DFW Policy
Updates a specific DFW security policy.
put Update DFW Rule
Updates a specific firewall rule for a given DFW security policy.
put Update DFW Rules
Updates firewall rules for a given DFW security policy.

DVpg Properties

get Get DVpg Properties
Returns the DVPG properties, such as promiscuous mode and forged transmit, of a specific Org vDC network. This is a SysAdmin only API.
put Update DVpg Properties
Toggles the DVPG properties of a specific Org vDC network. Allows for update of promiscuous mode and forged transmit. This is a SysAdmin only API.

Defined Entity

post Create Defined Entity
Creates a defined entity based on the entity type (URN).
post Create Metadata Entry
Creates a new entry.
delete Delete Defined Entity
Deletes the defined entity with the unique identifier (URN)
delete Delete Metadata Entry
Delete a single metadata entry.
get Get Defined Entities By Entity Type
Gets the collection of defined entities for the vCD-defined type with the specified vendor, nss and version.
get Get Defined Entities By Entity Type No Version Specified
Gets the collection of defined entities for the vCD-defined type with the specified vendor and nss.
get Get Defined Entities By Interface
Gets the collection of defined entities for the vCD-defined interface with the specified vendor, nss and version
get Get Defined Entity
Gets the defined entity with the unique identifier (URN)
get Get Metadata
Retrieves all the metadata for the entity.
get Get Metadata Entry
Get a single metadata entry.
get Get Metadata File Content
Download the binary content of a file entry
post Resolve Defined Entity
Validates the defined entity against the entity type schema.
put Update Defined Entity
Updates the defined entity with the unique identifier (URN)
put Update Metadata Entry
Update the value of a single key-value metadata entry.

Defined Entity Type

post Create Defined Entity Type
Creates a defined entity type.
delete Delete Defined Entity Type
Deletes the entity type with the unique identifier (URN)
get Get Defined Entity Type
Gets the entity type with the unique identifier (URN)
get Get Defined Entity Types
Gets the collection of entity types defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
put Update Defined Entity Type
Updates the entity type with the unique identifier (URN)

Defined Interface

post Create Interface
Creates a defined interface.
delete Delete Interface
Deletes the interface with the unique identifier (URN)
get Get Interface
Gets the interface with the unique identifier (URN)
get Query Interfaces
Gets the collection of interfaces defined in the vCD instance. Allows collection refinement through traditional FIQL-based filtering
put Update Interface
Updates the interface with the unique identifier (URN)

Defined Interface Behaviors

post Add Defined Entity Type Access
Adds an access control configuration of an entity type's behavior
post Add Interface Behavior
Add a new interface Behavior if the Interface is not in use
delete Delete Interface Behavior
Remove a Behavior from the Defined Interface.
get Get Behavior Execution Log
Download the execution log from a behavior invocation
get Get Defined Entity Type Access
Gets the access control configuration of the entity type's behaviors
get Get Defined Entity Type Behaviors
Get the Behaviors of the Defined Entity Type.
get Get Interface Behavior
Get a Behavior in the Defined Interface.
get Get Interface Behaviors
Get the Behaviors of the Defined Interface.
get Get Type Behavior
Get a Behavior in the Defined Type
post Invoke Defined Entity Behavior
Invokes a behavior on a defined entity
delete Remove Behavior Override
Remove a Behavior override from the Defined Entity Type.
put Set Defined Entity Type Access
Sets the access control configuration of the entity type's behaviors
put Update Interface Behavior
Update the execution of the specified Behavior in the Defined Interface
put Update Interface Behaviors
Update all the executions of the specified Behaviors (possibly removing or adding some)
put Update Type Behavior
Update the execution of the specified Behavior in the Defined Entity Type

Device Authorization

post Deny Device Authorization
Denies a device authorization request
post Find Device Authorization Request
Looks up a device authorization request for approval
post Grant Device Authorization
Grants a device authorization request

Edge Cluster

delete Delete Edge Cluster
Deletes a specific Edge Cluster
get Get Edge Cluster
Retrieves a specific Edge Cluster
put Update Edge Cluster
Updates a specific Edge Cluster

Edge Clusters

post Create Edge Cluster
Create a new Edge Cluster
get Get Edge Clusters
Get all Edge Clusters in the system

Edge Gateway

delete Delete Edge Gateway
Deletes a specific Edge Gateway
get Get Edge Gateway
Retrieves a specific Edge Gateway
get Get Used IP Addresses
Retrieve the list of IP addresses which are being used by the edge gateway.
put Update Edge Gateway
Updates a specific Edge Gateway

Edge Gateway BGP

get Get BGP Config
Retrieves the BGP configuration for a given Edge Gateway.
put Update BGP Config
Updates the BGP configuration on the Edge Gateway.

Edge Gateway BGP Neighbor

delete Delete BGP Neighbor
Deletes a specific BGP neighbor of edge gateway.
get Get BGP Neighbor
Retrieves a specific BGP neighbor of edge gateway.
get Get BGP Neighbor Status
Retrieves status of a specific BGP neighbor configured on an Edge Gateway.
put Update BGP Neighbor
Updates a specific BGP neighbor of edge gateway.

Edge Gateway BGP Neighbors

post Create BGP Neighbor
Creates a new BGP neighbor for the edge gateway.
get Get BGP Neighbors
Retrieves all BGP neighbors configured for the edge gateway.

Edge Gateway DHCP

get Get DHCP Forwarder
Retrieves DHCP Forwarder configuration on an Edge Gateway.
put Update DHCP Forwarder
Update DHCP Forwarder configuration on an Edge Gateway.

Edge Gateway DNS

delete Delete Edge Gateway DNS
Deletes DNS configuration of the edge gateway.
get Get Edge Gateway DNS
Retrieves DNS configuration of the edge gateway.
put Update Edge Gateway DNS
Updates DNS configuration of the edge gateway.

Edge Gateway Firewall Rule

delete Delete Firewall Rule
Deletes a specific firewall rule for a given edge gateway.
get Get Firewall Rule
Retrieves a specific firewall rule for a given edge gateway.
put Update Firewall Rule
Updates a specific firewall rule for a given edge gateway.

Edge Gateway Firewall Rules

delete Delete Firewall Rules
Deletes all the firewall rules for a given edge gateway.
get Get Firewall Rules
Retrieves all firewall rules for a given edge gateway.
put Update Firewall Rules
Updates firewall rules for a given edge gateway.

Edge Gateway IP Sec VPN Tunnel

delete Delete IP Sec VPN Tunnel
Deletes a specific IPSec tunnel for a given edge gateway.
get Get IP Sec VPN Tunnel
Retrieves a specific IPSec tunnel for a given edge gateway.
get Get IP Sec VPN Tunnel Default Connection Properties
Retrieves the default connection properties that are used for a given IPSec Tunnel in NSX-T when default is set or no security type is specified.
get Get IP Sec VPN Tunnel Statistics
Retrieves connection statistics for a given IPSec VPN Tunnel configured on an Edge Gateway.
get Get IP Sec VPN Tunnel Status
Retrieves status of a given IPSec VPN Tunnel configured on an Edge Gateway.
put Update IP Sec VPN Tunnel
Updates a specific IPSec tunnel for a given edge gateway.

Edge Gateway IP Sec VPN Tunnel Connection Properties

get Get IP Sec VPN Tunnel Connection Properties
Retrieves connection properties for a given IPSec VPN Tunnel configured on an Edge Gateway.
put Update IP Sec VPN Tunnel Connection Properties
Updates the connection properties for a given IPSec VPN Tunnel configured on an Edge Gateway.

Edge Gateway IP Sec VPN Tunnels

post Create IP Sec VPN Tunnel
Creates an IPSec tunnel on the Edge Gateway.
get Get IP Sec VPN Tunnels
Retrieves all IPSec tunnels for a given edge gateway.

Edge Gateway L2 VPN Tunnel

delete Delete L2 VPN Tunnel
Deletes a specific L2 VPN tunnel for a given edge gateway.
get Get L2 VPN Tunnel
Retrieves a specific L2 VPN tunnel for a given edge gateway.
get Get L2 VPN Tunnel Statistics
Retrieves connection statistics for a given L2 VPN Tunnel configured on an Edge Gateway.
get Get L2 VPN Tunnel Status
Retrieves status of a given L2 VPN Tunnel.
put Update L2 VPN Tunnel
Updates a specific L2 VPN tunnel for a given edge gateway.

Edge Gateway L2 VPN Tunnels

post Create L2 VPN Tunnel
Creates an L2 VPN tunnel on the Edge Gateway.
get Get L2 VPN Tunnels
Retrieves all L2 VPN tunnels for a given edge gateway.

Edge Gateway Load Balancer

get Get Load Balancer Config
Retrieves Load Balancer configuration on an Edge Gateway.
put Update Load Balancer Config
Update Load Balancer configuration on an Edge Gateway.

Edge Gateway Load Balancer Analytics

get Get Load Balancer Analytic Reports
Retrieves analytics for a specific load balancer.
get Get Load Balancer Supported Analytic Metrics
Retrieves all the supported metrics for load balancer analytic reports.

Edge Gateway Load Balancer Pool

delete Delete Load Balancer Pool
Deletes a specific Load Balancer Pool.
get Get Load Balancer Pool
Retrieves a specific Load Balancer Pool.
put Update Load Balancer Pool
Updates a specific Load Balancer Pool.

Edge Gateway Load Balancer Pools

post Create Load Balancer Pool
Creates a Load Balancer Pool.
get Get Pool Summaries For Gateway
Retrieves all Load Balancer Pool Summaries for a given Edge Gateway.

Edge Gateway Load Balancer Virtual Service

delete Delete Virtual Service
Delete the specified Virtual Service.
get Get Virtual Service
Get Virtual Service.
put Update Virtual Service
Update specified Virtual Service.

Edge Gateway Load Balancer Virtual Services

post Create Virtual Service
Create a new Virtual Service for a specific Edge Gateway.
get Get Virtual Service Summaries For Gateway
Get all Virtual Service Summaries for an Edge Gateway.

Edge Gateway NAT Rule

delete Delete NAT Rule
Deletes a specific NAT Rule configuration of the edge gateway based on the rule id passed in.
get Get NAT Rule
Retrieves a specific NAT Rule configuration of the edge gateway based on the rule id passed in.
put Update NAT Rule
Update a specific NAT Rule configuration of the edge gateway based on the rule id passed in.

Edge Gateway NAT Rules

post Create NAT Rule
Creates a NAT Rule on the Edge Gateway.
get Get NAT Rules
Retrieves all NAT Rules on the edge gateway.

Edge Gateway Prefix List

delete Delete Prefix List
Deletes a specific Prefix list for a given edge gateway.
get Get Prefix List
Retrieves a specific Prefix list for a given edge gateway.
put Update Prefix List
Updates a specific Prefix list for a given edge gateway.

Edge Gateway Prefix Lists

post Create Prefix List
Creates a new Prefix list on the edge gateway.
get Get Prefix Lists
Retrieves all Prefix lists for a given edge gateway.

Edge Gateway Qo S

get Get Gateway Qo S Config
Retrieves the Edge Gateway Rate Limiting (QoS) configuration.
put Update Gateway Qo S Config
Update Rate Limiting (QoS) configuration on an Edge Gateway.

Edge Gateway Route Advertisement

get Get Route Advertisement
Retrieve the list of subnets that will be advertised so that the Edge Gateway can route out to the connected external network.
put Update Route Advertisement
Updates the list of subnets that will be advertised so that the Edge Gateway can route out to the connected external network.

Edge Gateway SLAAC Profile

get Get SLAAC Profile
Retrieves the SLAAC profile on the edge gateway.
put Update SLAAC Profile
Creates a SLAAC profile or updates the existing one if it already exists.

Edge Gateway Static Routes

post Create Static Route
Creates a new static route configured on an Edge Gateway.
delete Delete Static Route
Deletes a specific static route of edge gateway.
get Get Static Route
Retrieves a specific static route configured on an Edge Gateway.
get Get Static Routes
Retrieves all static routes configured for the edge gateway.
put Update Static Route
Updates a specific static route configured on an Edge Gateway.

Edge Gateways

post Create Edge Gateway
Create a new edge gateway
get Get All Edge Gateways
Get all the edge gateways

Egress Point

delete Delete Egress Point
Deletes a specific Universal Egress Point.
get Get Egress Point
Retrieves a specific Universal Egress Point.
post Sync Egress Point
Sync/repair the egress point.

Egress Points

post Create Egress Point
Creates a new Universal Egress Point from a specified Edge Gateway and Org vDC.
get Get Egress Points
Get a list of Universal Egress Points for a Universal Router.

Email Settings

post Test Email Settings
Tests Email Settings and Connection

Entity

get Resolve Entity
Get specified entity object

Entity Quotas

put Assign Quotas To Group
Assign quotas to given target group.
put Assign Quotas To Org
Assign quotas to given target organization.
put Assign Quotas To Service Account
Assign quotas to given target service account.
put Assign Quotas To User
Assign quotas to given target user.
get Get Quotas For Group
Get the effective quotas applicable for the given group.
get Get Quotas For Org
Get the effective quotas applicable for the given organization.
get Get Quotas For Service Account
Get the effective quotas applicable for the given service account.
get Get Quotas For User
Get the effective quotas applicable for the given user.
get Get Quotas For V App
Get the effective quotas applicable for the given vapp.

External Network

post Create External Network
Create an external network
delete Delete External Network
Deletes a specific external network.
get Get Available IP Addresses
Retrieve the list of IP addresses available for use on the network.
get Get Edge Gateways For Provider Gateway Topology
Retrieve information about all the Edge Gateways which are associated with the Provider Gateway. This endpoint is only supported for external networks which are backed by NSX-T Tier-0 router.
get Get External Network
Retrieves a specific external network.
get Get IP Space Uplinks For Provider Gateway Topology
Retrieve information about all the IP Space uplinks which are associated with the Provider Gateway. This endpoint is only supported for external networks which are backed by NSX-T Tier-0 router.
get Get Used IP Addresses
Retrieve the list of IP addresses which are being used from the network.
put Update External Network
Updates a specific external network.

External Networks

get Get All External Networks
Get all external networks.

External Service

post Create External Service
Create external service.
delete Delete External Service
Delete an external service.
get Get External Service
Retrieve an external service.
get Get External Services
Query external services.
put Update External Service
Update an external service.

Feature Flag

get Get Feature Flag
Retrieves a specific feature flag.
put Update Feature Flag
Updates a specific feature flag to either enable or disable it.

Feature Flags

get Get Feature Flags
Get list of all feature flags visible to the user.

Firewall Group

delete Delete Firewall Group
Deletes a Firewall Group.
get Get Firewall Group
Retrieves a specific firewall group.
get Get Firewall Group Associated V Ms
Retrieves associated VMs for a specific firewall group.
put Update Firewall Group
Updates the Firewall Group.

Firewall Groups

post Create Firewall Group
Create a firewall group
get Get Firewall Groups
Retrieves the Firewall Groups.

Global Roles

post Add Rights To Global Role
Adds the specified rights to a global role.
post Create Global Role
Creates a new global role
delete Delete Global Role
Delete specified global role
get Get Global Role
Get specified global role
post Post Global Role Publish
Publishes the global role to the specified tenants
post Post Global Role Publish All
Publishes the global role to all tenants
post Post Global Role Unpublish
Revokes publication of the global role to the specified tenants
post Post Global Role Unpublish All
Unpublishes the global role from all tenants
get Query Global Role Rights
Gets a paged list of rights (as references) contained by a particular global role
get Query Global Role Tenants
Retrieves list of tenants for whom the global role is explicitly published
get Query Global Roles
Get list of global roles
put Replace Rights In Global Role
Replaces the existing set of rights in global role with the rights (as references) supplied.
put Set Global Role Tenants
Resets list of tenants for whom the global role is explicitly published
put Update Global Role
Update specified global role

Group

post Create Group
Create a new group.
delete Delete Group
Delete the specified group.
get Get Group
Get a specified group.
get Query Group Users
Get a list of users of any type that belong to the specified group.
get Query Groups
Get a list of groups.
put Update Group
Modify the details of the specified group.

IP Space Org Assignments

post Create IP Space Org Assignment
Create a new IP Space Org Assignment.
delete Delete IP Space Org Assignment
Delete an IP Space Org Assignment.
get Get IP Space Org Assignment
Get a an IP Space Org Assignment.
get Get IP Space Org Assignments
Get the Org assignments for an IP Space.
put Update IP Space Org Assignment
Update an IP Space Org Assignment.

IP Space Uplinks

post Create IP Space Uplink
Create a new IP Space Uplink.
delete Delete IP Space Uplink
Delete an IP Space Uplink.
get Get IP Space Uplink
Get an IP Space Uplink.
get Get IP Space Uplinks
Retrieves all the IP Space Uplinks.
put Update IP Space Uplink
Update an IP Space Uplink.

IP Spaces

post Allocate
Allocate floating IP addresses or IP Prefix blocks from an IP Space.
post Create IP Space
Create a new IP Space.
delete Delete IP Space
Delete an IP Space.
delete Delete IP Space IP Allocation
Delete an IP Space IP Allocation.
get Get Floating IP Suggestions
Suggests IP addresses to use in Edge Gateway services.
get Get IP Prefix Sequences
Retrieves the generated sequences for an IP Prefix.
get Get IP Prefix Suggestions
Suggests IP Prefixes to use for network definitions.
get Get IP Space
Get an IP Space.
get Get IP Space IP Allocation
Get an IP Space IP allocation.
get Get IP Space IP Allocations
Retrieves all the allocated IP addresses or IP Prefixes of an IP Space.
get Get IP Space Summaries
Retrieves all the IP Space summaries.
put Update IP Space
Update an IP Space.
put Update IP Space IP Allocation
Update an IP Space IP Allocation.

LDAP

get Search LDAP Groups
Search LDAP Groups
get Search LDAP Users
Search LDAP Users
post Sync LDAP
Synchronize LDAP users/settings
post Test LDAP
Tests LDAP Connection and Settings

Load Balancer Cloud

get Get Load Balancer Cloud
Get Load Balancer Cloud.
delete Unregister Load Balancer Cloud
Unregister the specified Load Balancer Cloud.
put Update Load Balancer Cloud
Update specified Load Balancer Cloud.

Load Balancer Clouds

get Get Load Balancer Clouds
Get all registered Load Balancer Clouds in the system.
post Register Load Balancer Cloud
Register a new Load Balancer Cloud.

Load Balancer Controller

get Get Load Balancer Controller
Get Load Balancer Controller
delete Unregister Load Balancer Controller
Unregister the specified Load Balancer Controller.
put Update Load Balancer Controller
Update specified Load Balancer Controller

Load Balancer Controllers

get Get Load Balancer Controllers
Get all registered Load Balancer Controllers in the system.
post Register Load Balancer Controller
Register a new Load Balancer Controller

Load Balancer Service Engine Group

delete Delete Service Engine Group
Delete the specified Load Balancer Service Engine Group.
get Get Service Engine Group
Get Load Balancer Service Engine Group.
post Sync Service Engine Group
Sync Load Balancer Service Engine Group.
put Update Service Engine Group
Update specified Load Balancer Service Engine Group.

Load Balancer Service Engine Group Assignment

delete Delete Service Engine Group Assignment
Delete the specified Load Balancer Service Engine Group Assignment.
get Get Service Engine Group Assignment
Get a Load Balancer Service Engine Group Assignment.
put Update Service Engine Group Assignment
Update a Load Balancer Service Engine Group Assignment.

Load Balancer Service Engine Group Assignments

post Create Service Engine Group Assignment
Create a new Load Balancer Service Engine Group Assignment.
get Get Service Engine Group Assignments
Get the assignments for a Load Balancer Service Engine Group.

Load Balancer Service Engine Groups

post Create Service Engine Group
Create a new Load Balancer Service Engine Group.
get Get Service Engine Groups
Get all Load Balancer Service Engine Groups in the system.

Logical VM Groups

post Add Named VM Groups To Logical VM Group
Assign named vm groups to logical vm group.
post Create Logical VM Group
Creates a new logical vm group
delete Delete Logical VM Group
Delete specified logical vm group.
get Get Logical VM Group
Get specified logical vm group
get Get Logical VM Group Named VM Groups
Get all named vm groups associated with logical vm group
get Get Pvdc Policies For Logical VM Group
Get all pvdc policies associated with logical vm group
get Query Logical VM Groups
Get list of logical vm groups.
put Update Logical VM Group
Update specified logical vm group

Metadata Summary

get Get Metadata Summaries
Retrieves a map of entity ids to metadata summaries.

Multi VC VMS

delete Delete Multi VC VM
Delete the specified Multi VC VM.
get Get Multi VC VM
Get the Multi VC VM with the specified ID.
get Get Multi VC VMS
Get all Multi VC VMs in the system.

NSX ALB Resources

get Get Importable Clouds
Get all NSX-ALB Clouds from an NSX-ALB Controller.
get Get Importable Service Engine Groups
Get all importable Service Engine Groups from an NSX-ALB Cloud.

NSX V Resources

get Get Importable Transport Zones
Get all importable vxlan transport zones that are configured on a vCenter backed by a NSX-V manager.

NSX-T Resources

get Get Gateway Qo S Profiles
Get all Gateway QoS Profiles configured on an NSX-T manager.
get Get Importable Segment Subnet
Get subnet info for an importable segment
get Get Importable Segments
Get all importable segments
get Get Importable Tier 0 Routers
Get all importable Tier-0 routers that are accessible to an organization vDC.
get Get Importable Transport Zones
Get all importable overlay transport zones that are configured on an NSX-T manager.
get Get NSX-T Edge Clusters
Get all edge clusters that are configured on an NSX-T manager.
get Get Segment IP Discovery Profiles
Get all segment IP Discovery Profiles configured on an NSX-T manager.
get Get Segment Mac Discovery Profiles
Get all segment MAC Discovery Profiles configured on an NSX-T manager.
get Get Segment Qo S Profiles
Get all segment QoS Profiles configured on an NSX-T manager.
get Get Segment Security Profiles
Get all segment Security Profiles configured on an NSX-T manager.
get Get Segment Spoof Guard Profiles
Get all segment Spoof Guard Profiles configured on an NSX-T manager.

Network Context Profile

delete Delete Network Context Profile
Deletes a specific network context profile, removing the associated firewall rule and permitting the traffic this profile restricts.
get Get Network Context Profile
Get a specific network context profile.
put Update Network Context Profile
Updates a specific user-defined network context profile, changing the associated firewall and modifying the traffic this profile restricts.

Network Context Profile Attributes

get Get Network Context Profile Attributes
List all supported network context profile attributes and sub-attributes for the given NSX-T manager.

Network Context Profiles

post Create Network Context Profile
Create a user-defined network context profile.
get Get Network Context Profiles
Get all network context profiles.
post Sync Network Context Profiles
Sync the network context profiles from the network provider to VCD.

Network Pool

delete Delete Network Pool
Deletes a specific network pool.
get Get Network Pool
Retrieves a specific Network Pool.
post Sync Network Pool
Synchronize the VXLAN network pool.
put Update Network Pool
Updates a specific network pool.

Network Pools

post Create Network Pool
Create a new network pool.
get Get Network Pools Summary
Get summary of all the Network Pools in the system.

OIDC Relying Party

delete Delete OIDC Relying Party
Deletes a specific OIDC relying party.
get Get OIDC Relying Party
Retrieves a specific OIDC relying party.
get Query OIDC Relying Parties
Retrieve OIDC relying parties.
post Regenerate OIDC Relying Party Secret
Regenerate the client secret of an OIDC relying party.
post Register OIDC Relying Party
Register an OIDC relying party.
put Update OIDC Relying Party
Updates a specific OIDC relying party.

Open ID Provider Configuration

get Get Open ID Provider Configuration
Get the OpenID Provider configuration.
put Update Open ID Provider Configuration
Updates the OpenID Provider configuration.

Open ID Provider Key

post Create Open ID Provider Key
Adds a new OpenID Provider signing key to list of available keys.
delete Delete Open ID Provider Key
Delete the specified OpenID Provider key.
get Get Open ID Provider Key
Get the specified OpenID Provider key.
get Query Open ID Provider Keys
Query the list of all configured OpenID Provider keys.
put Update Open ID Provider Key
Updates the specified OpenID Provider key entry.

Org

post Create Org
Create a new organization
delete Delete Org
Delete the specified org.
get Get Org
Get specified organization.
get Query Orgs
Get list of all orgs accessible to the user.
put Update Org
Updates an organization.

Org VDC Network

delete Delete Network
Deletes a specific Org vDC network.
get Get Additional Properties
Returns the additional properties of a specific Org vDC network. This is a System Administrator only API.
get Get Allocated IP Addresses
Retrieve the list of IP addresses allocated to the network.
get Get Network Segment Profiles
Retrieves the segment profiles configuration for an Org vDC Network.
get Get Org VDC Network
Retrieves a specific Org vDC network.
get Get Secondary Allocated IP Addresses
Retrieve the list of secondary IP addresses allocated to the network, if the network is a dual stack network.
post Reset Network
Reset a specific isolated Org vDC network.
post Sync Org VDC Network
Sync/repair a specific Org vDC network.
post Sync Syslog Settings Of Network
Synchronize syslog server settings for a Org vDC network.
put Update Network
Updates a specific Org vDC network.
put Update Network Segment Profiles
Updates the segment profiles configuration for an Org vDC Network.

Org VDC Network DHCP

post Create DHCP Binding
Creates a DHCP binding on an Org vDC Network.
delete Delete DHCP Binding
Delete a specific DHCP binding of the Org vDC Network.
delete Delete Network DHCP Config
Removes Dhcp configuration on a specific Org vDC network.
get Get DHCP Binding
Retrieve a specific DHCP binding of the Org vDC Network.
get Get DHCP Bindings
Retrieves all DHCP bindings for an Org vDC Network.
get Get Network DHCP Config
Retrieves Dhcp configuration of a specific Org vDC network.
put Update DHCP Binding
Update a specific DHCP binding of the Org vDC Network.
put Update Network DHCP Config
Updates Dhcp configuration of a specific Org vDC network.

Org VDC Networks

post Create Network
Create an organization vDC network.
get Get All VDC Networks
Get all Org vDC networks.

Org VDC Storage Policy

get Get Org VDC Storage Policies
Get a paged list of all organization VDC level storage policies in the system
get Get Org VDC Storage Policy
Get specified Org VDC storage policy.
get Get Org VDC Storage Policy Consumers
Get a paged list of the entities that consume the specified Org VDC storage policy.
get Get Org VDC Storage Policy Supported Entity Types
Get a paged list of the supported entity types for the specified Organization VDC storage policy.

Preferences

get Get Preference
Get specified user preference.
get Get Preference Definition
Get specified preference definition.
get Query Preference Definitions
Get list of preference definitions.
get Query Preferences
Query user preferences.
put Update Preference
Update specified user preference

Provider VDC

get Get All Provider VD Cs
Get all provider VDCs.
get Get Child Resource Pools
Browse valid root resource pools hierarchy to back a Provider VDC.
get Get Merge Candidates For Pvdc
Get all provider VDCs that are valid merge candidates to be merged into the specified target provider VDC.
get Get Root Resource Pools
Browse valid root resource pools hierarchy to back a Provider VDC.

Proxy

post Create Proxy
Creates a proxy.
delete Delete Proxy
Delete a specific proxy. Will not delete an enabled proxy unless force is specified.
get Get Proxies
Gets a paged list of proxies for a tenant.
get Get Proxies Pac File For Tenant
Gets the tenant-specific .pac file listing proxies accessible to the tenant.
get Get Proxy
Retrieves a specific proxy.
get Get Proxy CRL
Retrieve a proxy certificate revocation list in PEM format.
get Get Proxy Certificate
Retrieve a proxy SSL certificate chain in PEM format.
get Get Proxy Certificate Thumbprint
Retrieve a Proxy SSL certificate thumbprint and algorithm used for calculation. Only SHA-256 is supported.
put Update Proxy
Update a specific proxy.
put Update Proxy CRL
Update a proxy certificate revocation list in PEM format.
put Update Proxy Certificate
Update a proxy certificate chain in PEM format.

Proxy Configuration

post Create Proxy Configuration
Creates a proxy configuration.
delete Delete Proxy Configuration
Delete a specific proxy configuration.
get Get Proxy Configuration
Retrieves a specific proxy configuration.
get Query Proxy Configurations
Gets a paged list of proxy configurations.
put Update Proxy Configuration
Update a specific proxy configuration.

Pvdc Compute Policies

post Create Pvdc Compute Policy
Creates a new provider vDC compute policy
delete Delete Pvdc Compute Policy
Delete specified provider vDC compute policy.
get Get Pvdc Compute Policy
Get specified provider vDC compute policy
get Get Pvdc Compute Policy VMS
Get all VMs associated with this pVDC compute policy
get Query Pvdc Compute Policies
Get list of provider vDC compute policies.
put Update Pvdc Compute Policy
Update specified provider vDC compute policy

Pvdc Compute Policies 2

post Create Pvdc Compute Policy
Creates a new provider vDC compute policy
delete Delete Pvdc Compute Policy
Delete specified provider vDC compute policy.
get Get Pvdc Compute Policy
Get specified provider vDC compute policy
get Query Pvdc Compute Policies
Get list of provider vDC compute policies.
get Query Virtual Machine Classes
Get a list of Virtual Machine Classes associated with this policy.
put Update Pvdc Compute Policy
Update specified provider vDC compute policy

Pvdc Storage Policy

get Get All Supported Storage Entity Types
Get a paged list of all supported entity types configured for storage policies in the system
get Get Pvdc Storage Policies
Get a paged list of all Provider VDC level storage policies in the system
get Get Pvdc Storage Policy
Get specified Provider VDC storage policy.
get Get Pvdc Storage Policy Inheritable Settings
Retrieves the settings that child Org VDC storage policies of this provider VDC storage policy should inherit.
get Get Pvdc Storage Policy Supported Entity Types
Get a paged list of the supported entity types for the specified Provider VDC storage policy.
put Update All Storage Policy Supported Entity Types
Updates the supported entity types for the specified provider VDC storage policy.
put Update Pvdc Storage Policy Inheritable Settings
Updates the settings that child Org VDC storage policies of this provider VDC storage policy should inherit.
put Update Pvdc Storage Policy Supported Entity Types
Updates the supported entity types for the specified provider VDC storage policy.

Quota Policies

post Create Quota Policy
Creates a new quota policy
delete Delete Quota Policy
Delete the specified quota policy.
get Get Quota Policy
Get the specified quota policy
get Query Quota Policies
Get list of quota policies.
put Update Quota Policy
Update the specified quota policy

Quota Policy Assignment

put Assign Quota Policy To Group
Assign or unassign a quota policy to a given target group. An empty payload is used to unassign an existing quota policy from a given group.
put Assign Quota Policy To Org
Assign or unassign a quota policy to a given target organization. An empty payload is used to unassign an existing quota policy from a given organization.
put Assign Quota Policy To Service Account
Assign or unassign a quota policy to a given target service account. An empty payload is used to unassign an existing quota policy from a given service account.
put Assign Quota Policy To User
Assign or unassign a quota policy to a given target user. An empty payload is used to unassign an existing quota policy from a given user.
put Assign Quota Policy To V App
Assign or unassign a quota policy to a given target vapp. An empty payload is used to unassign an existing quota policy from a given vapp.
get Get Group Assigned Quota Policy
Get the assigned quota policy reference for the given group.
get Get Org Assigned Quota Policy
Get the assigned quota policy reference for the given organization.
get Get Service Account Assigned Quota Policy
Get the assigned quota policy reference for the given service account.
get Get User Assigned Quota Policy
Get the assigned quota policy reference for the given user.
get Get V App Assigned Quota Policy
Get the assigned quota policy reference for the given vapp.

Rights

get Get Right
Retrieve an individual right.
get Query Rights
Get list of rights visible to logged-in user

Rights Bundles

post Add Rights To Rights Bundle
Adds the specified rights to a rights bundle.
post Create Rights Bundle
Creates a new rights bundle
delete Delete Rights Bundle
Delete specified rights bundle
get Get Rights Bundle
Get specified rights bundle
post Post Rights Bundle Publish
Publishes the rights bundle to the specified tenants
post Post Rights Bundle Publish All
Publishes the rights bundle to all tenants
post Post Rights Bundle Unpublish
Revokes publication of the rights bundle to the specified tenants
post Post Rights Bundle Unpublish All
Unpublishes the rights bundle from all tenants
get Query Rights Bundle Rights
Gets a paged list of rights (as references) contained by a particular bundle
get Query Rights Bundle Tenants
Retrieves list of tenants for whom the rights bundle is explicitly published
get Query Rights Bundles
Get list of rights bundles
put Replace Rights In Rights Bundle
Replaces the existing set of rights in bundle with the rights (as references) supplied.
put Set Rights Bundle Tenants
Resets list of tenants for whom the rights bundle is explicitly published
put Update Rights Bundle
Update specified rights bundle

Rights Categories

get Get Rights Category
Retrieve an individual Right category.
get Query Rights Categories
Get a list of Rights Categories visible to the logged in user

Roles

post Add Rights To Role
Adds the specified rights to a role.
post Create Role
Creates a new role
delete Delete Role
Delete specified role
get Get Role
Get specified role
get Query Role Rights
Gets a paged list of rights (as references) contained by a particular role
get Query Tenant Roles
Get list of roles for a tenant
put Replace Rights In Role
Replaces the existing set of rights in role with the rights (as references) supplied.
put Update Role
Update specified role

SDDC Proxy

post Create SDDC Proxy
Creates an SDDC proxy.
delete Delete SDDC Proxy
Delete a specific SDDC proxy. Will not delete an enabled proxy unless force is specified.
get Get SDDC Proxies
Gets a paged list of SDDC proxies for a tenant.
get Get SDDC Proxies Pac File
Gets the .pac file for the user's accessible proxies.
get Get SDDC Proxy
Retrieves a specific SDDC proxy.
get Get SDDC Proxy CRL
Retrieve a SDDC proxy certificate revocation list in PEM format.
get Get SDDC Proxy Certificate
Retrieve a SDDC proxy SSL certificate chain in PEM format.
get Get SDDC Proxy Certificate Thumbprint
Retrieve a SDDC Proxy SSL certificate thumbprint. The thumbprint is the SHA-1 hash of the DER encoding of the certificate.
put Update SDDC Proxy
Update a specific SDDC proxy.
put Update SDDC Proxy CRL
Update a SDDC proxy certificate revocation list in PEM format.
put Update SDDC Proxy Certificate
Update a SDDC proxy certificate chain in PEM format.

SDDCs

post Create SDDC
Create a Software-Defined Datacenter.
post Create SDDC Endpoint
Creates an SDDC endpoint.
delete Delete SDDC
Delete a specific Software-Defined Datacenter. Unless force is specified, SDDC & its proxies must be disabled before they can be deleted.
delete Delete SDDC Endpoint
Delete a specific SDDC endpoint. Will not delete a default endpoint.
get Get Endpoints For SDDC
Retrieve the endpoints for the SDDC.
get Get Proxies For SDDC
Retrieve the proxies for the Software-Defined Datacenter.
get Get SDDC
Retrieve a specific Software-Defined Datacenter.
get Get SDDC Endpoint
Retrieves a specific SDDC endpoint.
get Get SDDC Owner
Retrieve the owner of the Software-Defined Datacenter.
get Get SDDCs
Get the list of Software-Defined Datacenters accessible to the user.
get Query SDDC Tenants
Retrieve the list of tenants a Software-Defined Datacenter is published to.
post SDDC Publish To Tenants
Publish a Software-Defined Datacenter to the given tenants.
post SDDC Unpublish From Tenants
Revoke publication of the Software-Defined Datacenter for the tenants.
put Set SDDC Owner
Update the owner of the Software-Defined Datacenter.
put Set SDDC Tenants
Reset the list of tenants a Software-Defined Datacenter is published to.
put Update SDDC
Update a specific Software-Defined Datacenter.
put Update SDDC Endpoint
Update a specific SDDC endpoint.

SSL Settings

get Get SSL Settings
Get the SSL settings
put Update SSL Settings
Updates the SSL settings.

Security Tags

get Get Security Tagged Entities
Retrieves the list of entities that have at least one tag assigned to it.
get Get Tag Values
Retrieves the list of security tags that are in the organization.
get Get VM Tags
Retrieves the list of tags for a specific VM.
put Update Security Tag
Updates a specific tag
put Update VM Tags
Update the list of tags for a specific VM.

Segment Profile Templates

post Create Segment Profile Template
Creates a new Segment Profile Template.
delete Delete Segment Profile Template
Deletes the specified Segment Profile Template.
get Get Global Default Segment Profile Templates
Retrieve the global defaults for segment profile templates
get Get Segment Profile Template
Retrieves a Segment Profile Template.
get Get Segment Profile Templates
Retrieves all Segment Profile Templates.
post Sync Segment Profile Template
Sync the Segment Profile Template.
put Update Global Default Segment Profile Templates
Updates the global defaults for segment profile templates
put Update Segment Profile Template
Updates a Segment Profile Template.

Service Account

delete Delete Service Account
Deletes a service account
get Get Service Account
Retrieves a specific service account
get Query Service Accounts
Retrieve service accounts
post Revoke Service Account
Revokes the token associated with the given service account.
post Take Ownership
Transfer ownership of this service account's owned entities to the caller.
put Update Service Account
Updates a service account

Service App

delete Delete Service App
Deletes a specific VMware service application.
get Get Service App
Retrieves a specific VMware service application
put Update Service App
Updates a specific VMware service application.

Service Apps

post Create Service App
Create a VMware service app
get Query Service Apps
Get all registered VMware service applications

Services

post Create Service
Creates a new service
delete Delete Service
Delete specified service
delete Delete Service Item
Deletes specified service item
get Get Service
Get specified service
get Get Service Item
Get the specified item
get Get Service Item Tenants
Retrieves list of tenants for whom the service item is explicitly published
get Get Service Item Tenants Query
Retrieves paginated list of tenants for whom the service item is explicitly published
get Get Workflow Service Items
This endpoint will not produce results. It is a placeholder to enforce code generation of VroWorkflowServiceItem
post Import vRO Workflows
Add VRO remote workflows to this service
post Post Service Item Publish
Publishes the service item to the specified tenants
post Post Service Item Publish All
Publishes the service item to all tenants
post Post Service Item Publish All Bounded
Publishes the service item to all tenants
post Post Service Item Publish Bounded
Publishes the service item to the specified tenants
post Post Service Item Unpublish
Revokes publication of the service item to the specified tenants
post Post Service Item Unpublish All
Unpublishes the service item from all tenants
post Post Service Item Unpublish All Bounded
Unpublishes the service item from all tenants
post Post Service Item Unpublish Bounded
Revokes publication of the service item to the specified tenants
get Query Service Items
Get all items across all services
get Query Services
Get list of services
put Set Service Item Tenants
Resets list of tenants for whom the service item is explicitly published
put Set Service Item Tenants Bounded
Resets list of tenants for whom the service item is explicitly published
put Update Service
Update specified service
put Update Service Item
Update specified service item

Sessions

get Get Accessible Locations
Get locations accessible to this session.
get Get Current Session
Returns the current session identified by credentials supplied using the Authorization header
get Get Current Sessions
List all sessions for current user
get Get Session
Returns the specified session for current user
get Get Token
Get token associated with this session.
post Login
Logs in a user
delete Logout
Logs out the current user
delete Logout Current Session
Logout current session
post Provider Login
Logs in a user (Provider only)

Site Association

get Get Site Association
Get specified site association.
get Query Site Associations
Get list of site associations accessible to the user.

Site Settings

get Get Site Settings Links
Retrieve links for navigating site settings.

Storage Container

get Get Datastore Cluster Datastores
Retrieves all Datastores associated with the specified Datastore Cluster.
get Get Storage Container
Get specified Datastore or Datastore Cluster.
get Get Storage Containers
Get a paged list of all standalone Datastores and Datastore Clusters in the system

Storage Policy

get Get Storage Policies
Get a paged list of all Provider Storage Policies in the system
get Get Storage Policy
Get specified Storage Policy.

Test Connection

post Test
Test a connection

Token

post Create Token
Creates a new token of the specified type
delete Delete Token
Delete a specific token. Use this to revoke the current token in case of a leak.
get Get Token
Retrieves a specific token
get Get Tokens
Retrieve tokens

Transfer Sessions

get Get Transfer Session
Get specified transfer session
get Query Transfer Session Items
Get list of transfer items associated with this transfer session.
get Query Transfer Sessions
Get list of active transfer sessions

Trusted Certificates

delete Delete Certificate
Revoke trusting specified certificate
get Get Certificate
Get specified certificate
get Query Trusted Certificates
Get currently trusted certificates
post Trust Certificate
Add to list of currently trusted certificates
put Update Certificate
Updates an existing trusted certificate

Type Access Controls

post Create Entity Type Access Control Grant
Creates an access-control grant for an entity type
get Get Entity Type Access Control Grant
Get the specified access-control grant.
get Query Entity Type Access Control Grants
Get the access-control list for the specified vCD entity type.
delete Remove Entity Type Access Control Grant
Removes the specified access-control grant from the vCD entity type access-control list.
put Update Entity Type Access Control Grant
Updates the specified access-control grant.

UI Plugin

delete Delete UI Plugin
Delete system level logo
get Get Extension Point Summary
Retrieves a map of extension Points and an ordered list of items registered with that extension point
get Get UI Plugin
Retrieves extension specific plugin metadata
put Put Extension Point Summary
Customizes the order and enables/disables extension Points
put Put UI Plugin
Updates extension specific plugin's metadata

UI Plugin Resource

delete Delete UI Plugin Resource
Delete the plugin for this extension
post Upload UI Plugin Resource
Upload the plugin for this extension

UI Plugin Tenants

get Get UI Plugin Tenants
Retrieves list of tenants for whom the plugin is explicitly published
post Post UI Plugin Publish
Publishes the UI plugin to the specified tenants
post Post UI Plugin Publish All
Publishes the UI plugin to all tenants
post Post UI Plugin Unpublish
Revokes publication of the UI plugin to the specified tenants
post Post UI Plugin Unpublish All
Unpublishes the UI plugin from all tenants

UI Plugins

post Add UI Plugin
Adds plugin metadata for a new UI Extension
get Get UI Plugins
Get a list of all UI Extensions

Universal Router

delete Delete Universal Router
Deletes a specific Universal Router
get Get Universal Router
Retrieves a specific Universal Router
post Sync Universal Router
Sync/repair the Universal Router
put Update Universal Router
Updates a specific Universal Router

Universal Router DHCP

delete Delete DHCP Config For Universal Router
Deletes Dhcp configuration of a specific Universal Router
get Get DHCP Config For Universal Router
Retrieves Dhcp configuration of a specific Universal Router
put Update DHCP Config For Universal Router
Updates Dhcp configuration for a specific Universal Router

Universal Router DNS

delete Delete DNS Config For Router
Deletes dns configuration of a universal router
get Get DNS Config For Router
Retrieves dns configuration of a universal router
put Update DNS Config For Router
Updates dns configuration of a universal Router

Universal Router Health

get Get Universal Router Health
Get Health information of a universal router

Universal Routers

post Create Universal Router
Create a new universal router
get Get All Universal Routers For VDC Group
Get all the universal routers defined for a vDC group

Universal Routing

get Get Universal Egress Routing
Retrieves Universal Egress Points and routing configuration for a Universal Router.
get Get Universal Routes
Retrieves routing configuration for a Universal Router.
post Sync Universal Routes
Sync/repair the routing configuration for a Universal Router.
put Update Universal Egress Routing
Updates the routing configuration using the specified egress points in the universal routes. Any egress point that does not exist will be created before updating routing. Any egress point that currently exists and is not in use by any of the specified routes will be deleted. If the new egress points for routing fail to create, routing will not be updated.
put Update Universal Routes
Updates routing configuration for a Universal Router.

User

post Change Password
Modify the existing password of a local user.
post Create User
Create a new user.
delete Delete User
Delete the specified user.
get Get User
Get a specified user by id. If the id of a service account is specified instead, a simplified view of the service account is returned instead.
get Query User Groups
Get a list of groups that the user with the given id belongs to.
get Query Users
Get a list of users.
post Take Ownership
Transfer ownership of this user's owned entities to the caller.
put Update User
Modify the details of a user. A non-administrator user may only modify their own password. An administrator can edit any user.

VDC

get Get Compute Policies
Retrieves all compute policies of a vDC
get Get VDC
Retrieves a specific vDC via URN.
get Get VDC Max Compute Policy
Retrieves Max Compute Policy of the vDC.
get Query VDCs
Retrieves a list of vDCs
put Update VDC Max Compute Policy
Updates Max Compute Policy of the vDC.

VDC 2

get Get Compute Policies
Retrieves all compute policies of a vDC
get Get VDC Max Compute Policy
Retrieves Max Compute Policy of the vDC.
put Update VDC Max Compute Policy
Updates Max Compute Policy of the vDC.

VDC Compute Policies

post Add VDC Compute Policy To VDCs
Assign this organization vDC compute policy to list of vDCs.
post Create VDC Compute Policy
Creates a new organization vDC compute policy
delete Delete VDC Compute Policy
Delete specified organization vDC compute policy.
get Get VDC Compute Policy
Get specified organization vDC compute policy
get Get VDC Compute Policy VDCs
Get organization vDCs associated with this vDC compute policy
get Get VDC Compute Policy VMS
Get all VMs associated with this vDC compute policy
get Query VDC Compute Policies
Get list of organization vDC compute policies.
put Update VDC Compute Policy
Update specified organization vDC compute policy

VDC Compute Policies 2

post Add VDC Compute Policy To VDCs
Assign this organization VDC compute policy to list of VDCs.
post Create VDC Compute Policy
Creates a new organization VDC compute policy
delete Delete VDC Compute Policy
Delete specified organization VDC compute policy.
get Get VDC Compute Policy
Get specified organization VDC compute policy
get Get VDC Compute Policy Metrics
Get specified organization VDC compute policy metrics.
get Get VDC Compute Policy VDCs
Get orgatization VDCs this VDC compute policy has been assigned/published to
get Query VDC Compute Policies
Get list of organization VDC compute policies.
get Query Virtual Machine Classes
Get a list of Virtual Machine Classes associated with this policy.
put Update VDC Compute Policy
Update specified organization VDC compute policy

VDC Group

delete Delete VDC Group
Deletes a vDC Group
get Get VDC Group
Retrieves a specific vDC Group.
post Sync VDC Group
Sync/repair the vDC group. An example usage is to detect if a vDC still exists/is valid. If an Organization vDC referenced by the VDC group is deleted or if it is not participating in universal networking, it's status will be updated to OBJECT_NOT_FOUND and the vdc group will be marked as NOT_REALIZED. This will also initiate a sync of associated router, if any. The router entities like egress points and universal routes will also be marked as NOT_REALIZED if they reference the removed Organization vDC.
put Update VDC Group
Updates a specific vDC Group. Example is to add/remove a participarting vDC.

VDC Group Candidates

get Get Networking VDC Group Candidates
Get a list of candidate vDCs that can be added to a single vDC Group in the networking context.

VDC Groups

post Create VDC Group
Creates a vDC Group. A universal router will also be created if universalNetworkingEnabled is set to true.
get Get VDC Groups
Get a list of vDC Groups.

VDC Groups Settings

get Get VDC Group Settings
Retrieves the global vDC groups settings. These settings apply to all vDC Groups in the system and can only be retrieved by the provider.
put Update VDC Group Settings
Updates the global vDC groups settings. These settings apply to all vDC Groups in the system and can only be updated by the provider.

VDC Network Profile

delete Delete VDC Network Profile
Deletes/Reset a vDC Network Profile.
get Get VDC Network Profile
Retrieves the vDC Network Profile.
put Update VDC Network Profile
Updates the vDC Network Profile.

VMC SDDCs

get Get VMC SDDCs
Retrieves a list of SDDCs for a specific VMware service application that are available
post Register VMC SDDC
Register a VMware service application SDDC's components

Vgpu Profiles

delete Delete Vgpu Profile
Delete specified vGPU profile.
get Get Vgpu Profile
Get specified vGPU profile
get Query Vgpu Profiles
Get list of vGPU profiles
put Update Vgpu Profile
Update specified vGPU profile

Vgpu Profiles Consumers

get Query Vgpu Profiles Consumers
Get list of vGPU profiles consumer entities

Virtual Center

post Attach Virtual Center
Attach a Virtual Center server
delete Delete Virtual Center
Detach the specified Virtual Center server
get Get All Resource Pools
Get resource pools of a VC
get Get Child Resource Pools
Get resource pools of a VC
get Get NSX V Manager Settings
Get Virtual Center server network settings
get Get Resource Pool Kubernetes Config
Get kubernetes configuration for a resource pool.
get Get Root Resource Pools
Get resource pools of a VC
get Get Storage Profiles
Get storage profiles of a VC
get Get Supported Hardware Versions
Get supported hardware versions of a resource pool
get Get Unmanaged Virtual Machines
Get a list of unmanaged virtual machines from vCenter Server
get Get VC Storage Policy Capabilities
Retrieves capabilities of a specific Virtual Center storage policy.
get Get Virtual Center
Get Virtual Center server
get Get Virtual Center Metrics
Get Virtual Center server metrics
get Query Virtual Centers
Gets a paged list of Virtual Center servers.
get Query Virtual Machine Classes
Get a list of Virtual Machine Classes associated with this resource pool.
get Retrieve vSphere VMCA
Retrieve the VMCA certificate
put Update NSX V Manager Settings
Update specified Virtual Center server network settings
put Update Virtual Center
Update specified Virtual Center server

k8s Cluster

post Create k8s Cluster
Creates a new Kubernetes cluster. This operation is asynchronous and returns a task that you can monitor to track the progress of the request.
delete Delete k8s Cluster
post Generate Kubeconfig
Generate kubeconfig file for corresponding cluster
get Get k8s Cluster
Get specified Kubernetes Cluster
get Query k8s Clusters
Retrieves all K8s clusters
put Update k8s Cluster
Update the desired state of the Kubernetes cluster. This operation is asynchronous and returns a task that you can monitor to track the progress of the request.

vCenter Resources

get Get DV Switches
Retrieves all distributed virtual switches.
get Get Importable DVpgs
Get all DVPG network backings that are available.
get Get Importable Portgroups
Get all standard porgroups available as backings.

vRO Workflow Execution

delete Cancel Workflow Execution
Cancel workflow run
delete Delete Workflow Execution
Delete workflow run
get Get All Workflow Executions
Get all executions
get Get Parameter Types
This endpoint will not produce results. It is a placeholder to enforce code generation of ParameterTypes.
get Get Supported Decorators
This endpoint will not produce results. It is a placeholder to enforce code generation of SupportedDecorators.
get Get Supported Presentation Elements
This endpoint will not produce results. It is a placeholder to enforce code generation of SupportedPresentationElements.
get Get Supportedconstraints
This endpoint will not produce results. It is a placeholder to enforce code generation of SupportedConstraints.
get Get Workflow Execution
Get workflow execution
get Get Workflow Execution State
Get workflow execution state
post Start Workflow Execution
Start workflow execution

vRO Workflow Presentation

delete Delete Workflow Presenation Instance
Delete workflow presentation execution
get Get All Workflow Presentation Instances
Get all presentations
get Get Workflow Presentation
Get presentation
get Get Workflow Presentation Instance
Load Execution
post Start Workflow Presentation
Start presentation
put Update Workflow Presentation Instance
Update presentation

vRealize Browse

get Browse Sdk Objects
Browse remote vRealize Orchestrator inventory
get Get Plugin List
Browse remote vRealize Orchestrator inventory
get Get Plugin Type List
Browse remote vRealize Orchestrator inventory
get Get Remote Inventory
Browse remote vRealize Orchestrator inventory
get Search Sdk Objects
Browse remote vRealize Orchestrator inventory

vRealize Orchestrator

get Get Registered vRO
Retrieves service specific metadata for a vRealize Orchestrator
patch Patch Service
Updates service specific metadata for a vRealize Orchestrator
delete Unregister
Unregisters a vRealize Orchestrator endpoint from vCloud Director
put Update Service
Updates service specific metadata for a vRealize Orchestrator

vRealize Orchestrators

post Discover vRO vCenter
Discover vCenter to work with the provided vRealize Orchestrator service
get Get Registered VR OS
Get a list of registered vRealize Orchestrator services
post Register
Register a vRealize Orchestrator endpoint with vCloud Director

vRealize Workflows

get Get Remote Workflows
Browse remote vRealize Orchestrator workflows

Feedback

Was this page helpful?