---
name: vmware-service-api-virtual-private-ep
title: Using a Virtual Private Endpoint
description: After you created your IBM Cloud® Virtual Private Cloud (VPC) and you want to connect to IBM Cloud for VMware Cloud Foundation as a Service APIs to create or manage your instance, you can create a Virtual Private Endpoint (VPE) in your VPC to access VMware Cloud Foundation (VCF) as a Service APIs within your VPC network.
last-updated: 2025-12-08
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/vmware-service?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# Using a Virtual Private Endpoint
{: #virtual-private-endpoints}

{{site.data.content.vms-deprecated-note}}

After you created your IBM Cloud® Virtual Private Cloud (VPC) and you want to connect to IBM Cloud for VMware Cloud Foundation as a Service APIs to create or manage your instance, you can create a Virtual Private Endpoint (VPE) in your VPC to access VMware Cloud Foundation (VCF) as a Service APIs within your VPC network.
{: shortdesc}

You can configure the VPE to use the IP addresses of your choice from a subnet within your VPC. VPEs are bound to a [VPE gateway](https://cloud.ibm.com/docs/vpc?topic=vpc-about-vpe&format=markdown) and serve as an intermediary that enables your workload to interact with VCF as a Service.

To connect to VCF as a Service by using a VPE, you must use the VCF as a Service API. You must access the VMware Solutions console through a public network from your VPC.
{: note}

## Before you begin
{: #vpe-prereqs}

You must complete the following before you target a VPE for VCF as a Service.

- Ensure that you have [provisioned a Virtual Private Cloud](https://cloud.ibm.com/docs/vpc?topic=vpc-getting-started&format=markdown).
- Ensure that you have reviewed [planning for virtual private endpoint gateways](https://cloud.ibm.com/docs/vpc?topic=vpc-vpe-planning-considerations&format=markdown).
- Ensure that [correct access controls](https://cloud.ibm.com/docs/vpc?topic=vpc-vpe-iam&format=markdown) are set for your VPE.
- Ensure that you have [created](https://cloud.ibm.com/docs/vpc?topic=vpc-ordering-endpoint-gateway&format=markdown) and understand how to [access](https://cloud.ibm.com/docs/vpc?topic=vpc-accessing-vpe-after-setup&format=markdown) a VPE gateway.
- Understand how to [view details](https://cloud.ibm.com/docs/vpc?topic=vpc-vpe-viewing-details-of-an-endpoint-gateway&format=markdown) of a VPE.

You may need to manually update VPE settings, specifically the IP address, during disaster recovery and business continuity actions.
{: important}

## Virtual Private Service Endpoints
{: #vpe-endpoints}

The following table lists regions where VCF as a Service supports VPE. The table also provides VCF as a Service endpoints supported from each region. You can connect to VCF as a Service in another region using supported endpoints.

When connecting to a VPE using [CLI](https://cloud.ibm.com/docs/vpc?topic=vpc-ordering-endpoint-gateway&interface=cli&format=markdown)
or [API](https://cloud.ibm.com/docs/vpc?topic=vpc-ordering-endpoint-gateway&interface=api&format=markdown), you must specify the Cloud resource name of the region that you  use to connect to VCF as a Service. Use the following table to locate the Cloud resource name of the target region.
{: note}

| Region     | Supported endpoints   | Cloud resource name    |
|------------|----------------------------------|------------------------|
| Dallas | `api.private.us-south.vmware.cloud.ibm.com` |`crn:v1:bluemix:public:vmware:us-south:::endpoint:api:private.us-south.vmware.cloud.ibm.com` |
| Frankfurt | `api.private.eu-de.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:eu-de:::endpoint:api:private.eu-de.vmware.cloud.ibm.com` |
| Madrid | `api.private.eu-es.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:eu-es:::endpoint:api:private.eu-es.vmware.cloud.ibm.com` |
| Sao Paulo | `api.private.br-sao.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:br-sao:::endpoint:api:private.br-sao.vmware.cloud.ibm.com` |
| Tokyo | `api.private.jp-tok.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:jp-tok:::endpoint:api:private.jp-tok.vmware.cloud.ibm.com` |
| Toronto | `api.private.ca-tor.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:ca-tor:::endpoint:api:private.ca-tor.vmware.cloud.ibm.com` |
| Washington DC | `api.private.us-east.vmware.cloud.ibm.com` | `crn:v1:bluemix:public:vmware:us-east:::endpoint:api:private.us-east.vmware.cloud.ibm.com` |
{: caption="Private endpoints for interacting with VCF as a Service APIs over the IBM Cloud private network" caption-side="bottom"}