Recommended next steps

This pageapplies toApigee andApigee hybrid.

View Apigee Edge documentation.

What you're doing in this step

Follow the steps below to create and deploy a test API proxy. Finally, test the API proxy by sending an HTTP request to it.

Create and deploy an API proxy

Permissions required for this task

Creating and deploying proxies requires a minimum set of permissions. If you have the Apigee Org Admin role, you can complete this task. To learn about other roles you can employ, see Apigee roles.

The provisioning process for Apigee does not automatically create and deploy an API proxy for you. You must create and deploy a proxy manually.

To create and deploy your first proxy:

  1. In the Google Cloud console, go to theProxy development> API proxies page.

    Go to API proxies

  2. Be sure that your organization name is selected from the project picker in theGoogle Cloud pane. The organization name is the same as your Google Cloud project name.
  3. Click+ Create.

    TheCreate a proxy page opens.

  4. In theProxy template box, selectReverse proxy (most common).
  5. InStep 1: Proxy details, configure your proxy with the following values:
    Parameter nameValue
    Proxy namehello-world
    Base path/hello-world
    Target (Existing API)mocktarget.apigee.net
  6. ClickNext.
  7. InStep 2: Deploy (optional):
    • Deployment environments: Optional. Use the checkboxes to select one or more environments in which to deploy your proxy. If you prefer not to deploy the proxy at this point, leave theDeployment environments field empty. You can always deploy the proxy later.
    • Service Account: Optional. Attach a service account to your deployment to enable your proxy to access Google Cloud services, as specified in the service account's role and permissions.
  8. ClickCreate.

    Your new API proxy is created and deployed in the selected environment.

    Note:The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.
  9. TheProxy summary page for your newly created proxy opens. A green check mark underStatus indicates that the proxy was successfully deployed. If the proxy is not deployed, see Deploying an API proxy and follow the steps to deploy it manually.
  10. In the left navigation pane, selectManagement > Environments > Environment Groups.
  11. Copy the hostname for your environment group. You'll use this hostname to call the API proxy in the next steps.

Call the proxy with internal access

If you allowedinternal access in Step 4: Customize access routing, follow the instructions in: Calling an API proxy with internal-only access.

Call the proxy with external access

If you allowedexternal access in Step 4: Customize access routing, follow these steps:

  1. Set up a DNS entry for your host. Here are two ways to accomplish this task:
    • At your registrar, create an A record pointing your environment group hostname to the IP shown on the wizard page underConfigure DNS. For example, if your hostname issales.example.com and the IP is 10.23.0.2, then point the record forsales.example.com to the address10.23.0.2.
    • Use GoogleCloud DNS to map a URL to an IP address.
  2. Test the API proxy by sending the following request in a terminal window:Note: DNS changes are published immediately, but may take time to propagate. Because of this delay, you may have to wait up to an hour before you can call the sample proxy.
    curl -v -H "Host:YOUR_ENV_GROUP_HOSTNAME" \  https://YOUR_INSTANCE_IP_OR_DNS/hello-world

    Where:

    • The value of theHost header (YOUR_ENV_GROUP_HOSTNAME) is the hostname from theEnvironments > Environment Groups page.

    A successful request returns the string:Hello, Guest!. If your request is not successful, seeTroubleshooting.

Next steps

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.