From the Environment drop-down list, select the environment in which you want
to create a new API proxy. This section assumes the name of the environment is "test". You
created at least one environment in Step 5: Add an environment.
The hybrid UI displays a list of API proxies for that environment. If you haven't created any
proxies yet, the list is empty.
Click +Proxy in the upper right. The API Proxy Wizard starts.
Select Reverse proxy (most common), and click Next.
The Proxy details view is displayed.
Configure your proxy with the following settings:
Proxy Name: Enter "myproxy". The remaining steps in this section assume
that this is your proxy's ID.
Proxy Base Path: Automatically set to "/myproxy". The Proxy Base
Path is part of the URL used to make requests to your API. Edge uses the URL to
match and route incoming requests to the proper API proxy.
(Optional) Description: Enter a description for your new API proxy, such
as "Testing Apigee hybrid with a simple proxy".
Target (Existing API): Enter "https://mocktarget.apigee.net". This defines the
target URL that Apigee invokes on a request to the API proxy. The mocktarget service is
hosted at Apigee and returns simple data. It requires no API key or access token.
Your API proxy's details should look like the following:
Click Next.
On the Policies screen, select Pass through (no authorization) as the
security option.
Click Next.
On the Summary screen, click Create.
Hybrid generates the proxy (sometimes referred to as the proxy bundle):
Click Go to proxy list.
Hybrid displays the Proxies view, which displays a list of API proxies. The
new proxy should be at the top of the list, with a gray status indicator, meaning that it has
not yet been deployed.
2. Deploy your proxy to the cluster using the hybrid UI
After creating a new proxy, you must deploy it so that you can try it out. This section
describes how to deploy your new proxy using the hybrid UI.
To deploy an API proxy in the hybrid UI:
In the hybrid UI, select Develop > API Proxies.
Be sure the "test" environment is selected.
The UI displays your new proxy in the proxies list:
Click on the "myproxy" proxy.
The UI displays the API Proxies Overview tab for that proxy.
Notice that under Deployments, the Revision column shows
"Not deployed".
In the Revision column, expand the drop-down selector to choose the revision
to deploy.
The drop down list displays only "1" and "Undeploy".
Select "1"—the revision that you want to deploy—from the drop down list.
The UI prompts you to confirm the deployment:
Click Deploy.
The UI begins the process of deploying revision 1 of your new proxy to the cluster.
Note that deployment is not an instantaneous process. Hybrid's "eventually consistent"
deployment model means that a new deployment will be rolled out to the cluster over a short
period of time and not immediately.
While there are several ways to check the
deployment status of a proxy in the UI, the next two steps explain how to call the API proxy
you just deployed and how
to check the deployment status with a call to the Apigee APIs.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-26 UTC."],[[["\u003cp\u003eThis guide explains how to create a new API proxy using the Apigee hybrid UI's API Proxy Wizard, starting with selecting the "Reverse proxy" option and configuring settings like the proxy name, base path, and target API.\u003c/p\u003e\n"],["\u003cp\u003eAfter creating the API proxy, the next step involves deploying it to your cluster through the Apigee hybrid UI, where you select the specific revision you want to deploy and confirm the action.\u003c/p\u003e\n"],["\u003cp\u003eOnce the UI indicates the API proxy is deployed, you can test it by calling it using tools like cURL, utilizing the environment group's host alias and the proxy's base path in the URL.\u003c/p\u003e\n"],["\u003cp\u003eThe API proxy is designed to route incoming requests to the target API that you specify, in this example, it's set to "https://mocktarget.apigee.net", which returns sample data.\u003c/p\u003e\n"],["\u003cp\u003eIf encountering TLS/SSL errors due to self-signed certificates, a workaround is provided that involves using the ingress host and secure ingress port to make the API call using cURL.\u003c/p\u003e\n"]]],[],null,["| You are currently viewing version 1.5 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\nNow that you've configured and the hybrid UI, and installed and configured the\nruntime, you're ready to see how it all works together.\n\nThis section walks you through the following:\n\n1. **[Create a new API proxy](#create-proxy)** in the Apigee UI using the API Proxy Wizard\n2. **[Deploy your new proxy](#deploy)** to your cluster with the UI\n\n1. Create a new API proxy using the hybrid UI\n\nThis section describes how to create a new API proxy in the UI by using the API Proxy Wizard.\n\n**To create a simple API proxy using the API Proxy Wizard:**\n\n1. Open [Apigee UI](https://apigee.google.com) in a browser.\n2. Select **Develop \\\u003e API Proxies** in the main view.\n3. From the **Environment** drop-down list, select the environment in which you want to create a new API proxy. This section assumes the name of the environment is \"test\". You created at least one environment in [Step 5: Add an environment](/apigee/docs/hybrid/v1.5/precog-add-environment).\n\n The hybrid UI displays a list of API proxies for that environment. If you haven't created any\n proxies yet, the list is empty.\n4. Click **+Proxy** in the upper right. The API Proxy Wizard starts.\n5. Select **Reverse proxy** (most common), and click **Next** .\n\n The **Proxy details** view is displayed.\n6. Configure your proxy with the following settings:\n - **Proxy Name:** Enter \"myproxy\". The remaining steps in this section assume that this is your proxy's ID.\n - **Proxy Base Path:** Automatically set to \"/myproxy\". The **Proxy Base\n Path** is part of the URL used to make requests to your API. Edge uses the URL to match and route incoming requests to the proper API proxy.\n - (Optional)**Description:** Enter a description for your new API proxy, such as \"Testing Apigee hybrid with a simple proxy\".\n - **Target (Existing API):** Enter \"https://mocktarget.apigee.net\". This defines the target URL that Apigee invokes on a request to the API proxy. The mocktarget service is hosted at Apigee and returns simple data. It requires no API key or access token.\n\n Your API proxy's details should look like the following:\n\n7. Click **Next**.\n8. On the **Policies** screen, select **Pass through (no authorization)** as the security option.\n9. Click **Next**.\n10. On the **Summary** screen, click **Create** .\n\n Hybrid generates the proxy (sometimes referred to as *the proxy bundle*):\n\n | **NOTE:** In this case, the hybrid UI does *not* deploy the proxy to your cluster. You will do this in [the next step](#deploy).\n11. Click **Go to proxy list** .\n\n Hybrid displays the **Proxies** view, which displays a list of API proxies. The\n new proxy should be at the top of the list, with a gray status indicator, meaning that it has\n not yet been deployed.\n\n2. Deploy your proxy to the cluster using the hybrid UI\n\nAfter creating a new proxy, you must deploy it so that you can try it out. This section\ndescribes how to deploy your new proxy using the hybrid UI.\n\n**To deploy an API proxy in the hybrid UI:**\n\n1. In the hybrid UI, select **Develop \\\u003e API Proxies** .\n\n Be sure the \"test\" environment is selected.\n\n The UI displays your new proxy in the proxies list:\n\n2. Click on the \"myproxy\" proxy.\n\n The UI displays the **API Proxies Overview** tab for that proxy.\n\n Notice that under **Deployments** , the **Revision** column shows\n \"Not deployed\".\n3. In the **Revision** column, expand the drop-down selector to choose the revision to deploy.\n\n The drop down list displays only \"1\" and \"Undeploy\".\n4. Select \"1\"---the revision that you want to deploy---from the drop down list.\n\n The UI prompts you to confirm the deployment:\n\n5. Click **Deploy** .\n\n The UI begins the process of deploying revision 1 of your new proxy to the cluster.\n\n Note that deployment is not an instantaneous process. Hybrid's \"eventually consistent\"\n deployment model means that a new deployment will be rolled out to the cluster over a short\n period of time and not immediately.\n\nWhile there are [several ways](/apigee/docs/api-platform/deploy/ui-deploy-overview#viewing-deployment-status) to check the\ndeployment status of a proxy in the UI, the next two steps explain how to call the API proxy\nyou just deployed and how\nto check the deployment status with a call to the [Apigee APIs](/apigee/docs/reference/apis/apigee/rest).\n\n3. Call the API proxy\n\nWhen the [UI indicates\nyour proxy is deployed](/apigee/docs/hybrid/v1.5/ui-deploy-overview#view-deployment-status), you can try calling it using cURL or the REST client of your choice.\nFor example:\n\n1. Export your environment group's host alias to a variable: \n\n ```\n HOSTALIAS=your_host_alias\n ```\n2. Call the API proxy: \n\n ```\n curl -k https://$HOSTALIAS/myproxy\n ```\n\n\n For example: \n\n ```\n curl -v -k https://apitest.acme.com/myproxy\n ```\n\n If the call succeeds, you will see the following output: \n\n ```\n Hello, Guest!\n ```\n\n\nIf you used a self-signed certificate and you get a TLS/SSL error, try these steps instead:\n\n1. Export your environment group's host alias to a variable: \n\n ```\n HOSTALIAS=your_host_alias\n ```\n2. Export the ingress host: \n\n ```\n export INGRESS_HOST=$(kubectl -n istio-system get service \\\n istio-ingressgateway -o jsonpath='{.status.loadBalancer.ingress[0].ip}')\n ```\n3. Export the secure ingress port number: \n\n ```\n export SECURE_INGRESS_PORT=$(kubectl -n istio-system get \\\n service istio-ingressgateway -o jsonpath='{.spec.ports[?(@.name==\"https\")].port}')\n ```\n4. Call the API proxy: \n\n ```\n curl -H Host:$HOSTALIAS --resolve \\\n $HOSTALIAS:$SECURE_INGRESS_PORT:$INGRESS_HOST \\\n https://$HOSTALIAS:$SECURE_INGRESS_PORT/myproxy -k\n ```\n\n*[Google Cloud]: Google Cloud"]]
