Oracle Cloud Infrastructure Documentation

Listing API Deployments

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

Having deployed APIs on API gateways by creating API deployments, you might need to list the existing API deployments. For example, you might want to obtain the OCID of an API deployment.

    1. On the Gateways list page, select the API gateway containing the API deployments that you want to see. If you need help finding the list page or the API gateway, see Listing API Gateways.
    2. Under Resources, select Deployments.

      The Deployments list page opens. All API deployments in the selected API gateway are displayed in a table.

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

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

      where:

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

      For example:

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

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

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

      If you want to list all the API deployments on a particular API gateway in a compartment, include the --gateway-id parameter in the request and specify the API gateway's OCID. For example:

      oci api-gateway deployment list --compartment-id ocid1.compartment.oc1..aaaaaaaa7______ysq --gateway-id ocid1.apigateway.oc1..aaaaaaaab______hga

    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 ListDeployments operation to list API deployments.