Oracle Cloud Infrastructure Documentation

Listing API Gateways

Find out how to list existing API gateways with the API Gateway service.

Having created API gateways, you might need to list the existing API gateways. For example, you might want to see whether there are any API gateways that are no longer required, or quickly locate an API gateway by its OCID.

    1. Open the navigation menu  and select Developer Services. Under API Management, select Gateways.

      The Gateways list page opens. All API gateways in the selected compartment are displayed in a table.

    2. To view the API gateways in a different compartment, use the Compartment filter to switch compartments.

      You must have permission to work in a compartment to see the resources in it. If you're not sure which compartment to use, contact an administrator. For more information, see Understanding Compartments.

    3. To see more detail about an individual API gateway, select the name of the API gateway on the Gateways list page to show the Gateway Details page.

  • To list the API gateways in a compartment using the CLI:

    1. Configure your client environment to use the CLI (Configuring Your Client Environment to use the CLI for API Gateway Development).

    2. To list all the API gateways in a compartment, open a command prompt and run oci api-gateway gateway list to list the API gateways:

      oci api-gateway gateway list --compartment-id <compartment-ocid>

      where:

      • <compartment-ocid> is the OCID of the compartment containing the API gateway.

      For example:

      oci api-gateway gateway list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq

      If you want to list just those API gateways with a status of Active, include the --lifecycle-state ACTIVE parameter in the request. For example:

      oci api-gateway gateway list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --lifecycle-state ACTIVE

    For more information about using the CLI, see Command Line Interface (CLI). For a complete list of flags and options available for CLI commands, see CLI Help.

  • Run the ListGateways operation to list API gateways.