Oracle Cloud Infrastructure Documentation

Listing Subscribers

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

Having created subscribers, you might need to list the existing subscribers. For example, you might want to see which subscribers are currently active.

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

      The Subscribers list page opens. All subscribers in the selected compartment are displayed in a table.

    3. To view the subscribers 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.

    4. To see more detail about an individual subscriber, select the name of the subscriber on the Subscribers list page to show the Subscribers details page.

  • To list the subscribers 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 subscribers in a compartment, open a command prompt and run oci api-gateway subscriber list to list the subscribers:

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

      where:

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

      For example:

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

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

      oci api-gateway subscriber 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 ListSubscribers operation to list subscribers.