IBM Cloud Docs
Listing endpoint gateways in the region

Listing endpoint gateways in the region

You can list all virtual private endpoint gateways in the region by using the console, CLI, or API.

Listing endpoint gateways in the console

To list all endpoint gateways by using the IBM Cloud console:

From the IBM Cloud console, select the Navigation menu Navigation menu icon, then click Infrastructure VPC icon > Network > Virtual private endpoint gateways.

The Virtual private endpoint gateways for VPC page appears. Use this table to view endpoint gateways in the region.

Listing endpoint gateways from the CLI

Before you begin, set up your CLI environment.

To list all endpoint gateways in the region from the CLI, run the following command:

ibmcloud is endpoint-gateways \
   [--resource-group-id RESOURCE_GROUP_ID | --resource-group-name RESOURCE_GROUP_NAME] [--json]

Where:

  • --resource-group-id is the ID of the resource group. This option is mutually exclusive with --resource-group-name.
  • --resource-group-name is the name of the resource group. This option is mutually exclusive with --resource-group-id.
  • --json formats output in JSON.

Listing endpoint gateways with the API

To list endpoint gateways with the API, follow these steps:

  1. Set up your API environment.

  2. Store your EndpointGatewayId in a variable to be used in the API command:

    export EndpointGatewayId=<endpoint_gateway_id>
    
  3. List endpoint gateways:

    curl  -sH "Authorization:${iam_token}"
    "$vpc_api_endpoint/v1/endpoint_gateways?version=$api_version&generation=2"