---
name: vpc-pps-publish
title: Publishing and unpublishing a Private Path service
description: After you verify a successful connection to your Private Path service, you must publish your service for deployment to consumers.
last-updated: 2025-10-17
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/vpc?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.

# Publishing and unpublishing a Private Path service
{: #pps-activating}

After you verify a successful [connection to your Private Path service](https://cloud.ibm.com/docs/vpc?topic=vpc-pps-verify&format=markdown), you must publish your service for deployment to consumers.
{: shortdesc}

If a Private Path service is not published, it cannot be accessed outside of the account.
{: important}

Publishing allows any account to request access to the Private Path service. If need be, you can also unpublish where access is restricted to the account that created the Private Path service.

You can publish and unpublish an IBM Cloud® Private Path service using the console, CLI, API, or Terraform.

## Publishing a Private Path service in the console
{: #pps-ui-activating-private-path-service}
{: ui}

To publish a Private Path service in the IBM Cloud console, follow these steps:

1. From your browser, open the [IBM Cloud console](https://cloud.ibm.com/login) and log in to your account.
1. Select the **Navigation menu** ![Navigation menu icon](../icons/icon_hamburger.svg), then click **Infrastructure** ![VPC icon](../../icons/vpc.svg) > **Network** > **Private Path services**.
1. Locate the name of your new Private Path service in the table, and click the name to view the Private Path service details page.
1. Click **Publish** in the Actions menu ![Actions menu](../icons/action-menu-icon.svg "Actions").

   The Publication column in the Private Path services for VPC table changes to `Published`.

The Private Path service is now exposed for other accounts to connect to the service through Virtual Private Endpoint (VPE) gateways.

After publishing, the Private Path service name is visible to customers connecting to the Private Path service.

## Unpublishing a Private Path service in the console
{: #pps-ui-deactivating-private-path-service}
{: ui}

To unpublish a Private Path service in the IBM Cloud console, follow these steps:

1. From your browser, open the [IBM Cloud console](https://cloud.ibm.com/login) and log in to your account.
1. Select the **Navigation menu** ![Menu icon](../icons/icon_hamburger.svg), then click  **Infrastructure > Network > Private Path services**.
1. In the Private Path services for VPC table, locate the Private Path that you want to unpublish, then click the name of that Private Path service.
1. On the Private Path service details page, click the **Actions** menu, then click **Unpublish**.
1. Confirm that you want to unpublish your Private Path service.

## Publishing a Private Path service from the CLI
{: #pps-cli-publish-private-path-service}
{: cli}

The following example shows how to use the CLI to publish a Private Path service.

Before you begin, make sure to [set up your CLI environment](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=cli&format=markdown).

To publish a Private Path service from the CLI, follow these steps:

1. Enter the following command:

```sh
ibmcloud is private-path-service-gateway-publish PRIVATE_PATH_SERVICE_GATEWAY
    [--output JSON]
    [-f, --force]
    [-q, --quiet]
```
{: pre}

Where:

`PRIVATE_PATH_SERVICE_GATEWAY`
:   Indicates ID or name of the Private Path service.

`--output`
:   Indicates output format, only JSON is supported. One of: `JSON`.

`-q, --quiet`
:   Suppresses verbose output.


### Command examples
{: #cli-cmd-examples-activating-private-path-service}
{: cli}

- Publish a Private Path service:
   `ibmcloud is ppsgp r006-01cd30f7-e6f2-432f-9520-76247b1fbbe1`
   `ibmcloud is private-path-service-gateway-publish cli-ppsg-0`


## Unpublishing a Private Path service from the CLI
{: #pps-cli-unpublish-private-path-service}
{: cli}

The following example shows how to use the CLI to unpublish a Private Path service.

Before you begin, make sure to [set up your CLI environment](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=cli&format=markdown).

To unpublish a Private Path service from the CLI, follow these steps:

1. Enter the following command:

```sh
ibmcloud is private-path-service-gateway-unpublish PRIVATE_PATH_SERVICE_GATEWAY
    [--output JSON]
    [-f, --force]
    [-q, --quiet]
```
{: pre}

Where:

`PRIVATE_PATH_SERVICE_GATEWAY`
:   Indicates ID or name of the Private Path service.

`--output`
:   Indicates output format, only JSON is supported. One of: `JSON`.

`-q, --quiet`
:   Suppresses verbose output.


## Publishing a Private Path service with the API
{: #pps-api-publishing-private-path-service}
{: api}

To publish a Private Path service with the API, follow these steps:

1. Set up your [API environment](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=cli&format=markdown).
1. Store the following values in variables to be used in the API command:

   * `ppsgId` - Get your Private Path service and then populate the variable:

      ```sh
      export ppsgId=<your_ppsg_id>
      ```
      {: pre}


1. When all variables are initiated, publish your Private Path service:

      ```sh
      curl -X POST -sH "Authorization:${iam_token}" \
      "$vpc_api_endpoint/v1/private_path_service_gateways/$ppsgId/publish?version=$api_version&generation=2" \
      -d {}'
      ```
      {: codeblock}

## Unpublishing a Private Path service with the API
{: #pps-api-unpublishing-private-path-service}
{: api}

To unpublish a Private Path service with the API, follow these steps:

1. Set up your [API environment](https://cloud.ibm.com/docs/vpc?topic=vpc-set-up-environment&interface=cli&format=markdown).
1. Store the following values in variables to be used in the API command:

   * `ppsgId` - Get your Private Path service and then populate the variable:

      ```sh
      export ppsgId=<your_ppsg_id>
      ```
      {: pre}


1. When all variables are initiated, unpublish your Private Path service:

      ```sh
      curl -X POST -sH "Authorization:${iam_token}" \
      "$vpc_api_endpoint/v1/private_path_service_gateways/$ppsgId/unpublish?version=$api_version&generation=2" \
      -d {}'
      ```
      {: codeblock}

### Command examples
{: #cli-cmd-examples-unpublish-private-path-service}
{: cli}

- Publish a Private Path service:
   `ibmcloud is ppsgunp r006-01cd30f7-e6f2-432f-9520-76247b1fbbe1`
   `ibmcloud is private-path-service-gateway-unpublish cli-ppsg-0`

   

## Publishing a Private Path service with Terraform
{: #publishing-private-path-service-terraform}
{: terraform}

The following example publishes a Private Path network by using Terraform:

```terraform
resource "ibm_is_private_path_service_gateway_operations" "publish" {
  published = true
  private_path_service_gateway = ibm_is_private_path_service_gateway.ppsg.id
}
```
{: codeblock}

For documentation about Terraform resources, see the [Terraform Registry](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/is_private_path_service_gateway).{: external}

## Unpublishing a Private Path service with Terraform
{: #unpublishing-private-path-service-terraform}
{: terraform}

Terraform will support this feature after it reaches General Availability (GA) and is officially released.
{: note}

The following example unpublishes a Private Path network by using Terraform:

```terraform
resource "ibm_is_private_path_service_gateway_operations" "publish" {
  published = false
  private_path_service_gateway = ibm_is_private_path_service_gateway.ppsg.id
}
```
{: codeblock}

For documentation about Terraform resources, see the [Terraform Registry](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/is_private_path_service_gateway).{: external}

## Next steps
{: #pps-next-steps-after-activation}

1. [Communicate connection information to consumers](https://cloud.ibm.com/docs/vpc?topic=vpc-pps-ui-communicate&format=markdown)
1. [Review connection requests](https://cloud.ibm.com/docs/vpc?topic=vpc-pps-ui-reviewing&interface=ui&format=markdown) and [Create account policies](https://cloud.ibm.com/docs/vpc?topic=vpc-pps-create-account-policy&interface=ui&format=markdown)