Oracle Cloud Infrastructure Documentation

Listing API Resources

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

Having created API resources, you might need to list the existing API resources. For example, you might want to see which API resources have been successfully validated.

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

      The APIs list page opens. All API resources in the selected compartment are displayed in a table.

    2. To view the API resources 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 resource, select the name of the API resource on the APIs list page to show the API Details page.

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

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

      where:

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

      For example:

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

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

      oci api-gateway api 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 ListApis operation to list API resources.