You're viewing **Apigee Edge** documentation.  
[Go to the
**Apigee X** documentation](http://cloud.google.com/apigee/docs/api-platform/get-started/create-proxy). info

Apigee Edge enables you to quickly expose backend services as APIs. You do this by creating an
API proxy that provides a facade for the backend service that you want to expose. You only need
to provide the network address for the backend service, along with some information that Edge
uses to create the API proxy that is exposed to developers.

The API proxy decouples your backend service implementation from the API that developers
consume. This shields developers from future changes to your backend services. As you update
backend services, developers, insulated from those changes, can continue to call the API
uninterrupted.

> [!NOTE]
> See also the [Build your first API proxy](https://docs.apigee.com/api-platform/get-started/get-started.md.txt) for a complete tutorial on creating an API proxy using the UI.

Watch this video for an overview of the process of creating an API proxy.
<iframe allowfullscreen frameborder="0" height="315" src="https://www.youtube.com/embed/ZtINy7n9QRc" width="560"></iframe>

## Creating an API proxy using the UI

The easiest way to create an API proxy is using the Create Proxy wizard.

### Edge

To access the Create Proxy wizard using the Edge UI:

1. Sign in to [apigee.com/edge](https://apigee.com/edge).
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click **+Proxy**.

The Create Proxy wizard displays and leads you through the steps to generate and add minimal features to an API proxy.

![First page of the Create Proxy wizard prompting you to select reverse proxy, SOAP service, No Target, or Proxy bundle to customize the wizard flow.](https://docs.apigee.com/static/api-platform/images/tutorial-proxy-type-v2.png)

### New Edge UI (Private Cloud)

> [!NOTE]
> **Note:** The New Edge UI is available with Edge for Private Cloud only.

To access the Create Proxy wizard using the New Edge UI:

1. Sign in to the New Edge UI at `http://host:3001/edge`, where <var translate="no">host</var> is the IP address or DNS name of the host running the New Edge UI.
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click **+Proxy**.

The Create Proxy wizard displays and leads you through the steps to generate and add minimal features to an API proxy.

![First page of the Create Proxy wizard prompting you to select reverse proxy, SOAP service, No Target, or Proxy bundle to customize the wizard flow.](https://docs.apigee.com/static/api-platform/images/tutorial-proxy-type-v2.png)

The first page of the wizard enables you create an API proxy from the following sources:

| Type | Description |
|---|---|
| Reverse proxy (most common) | An API proxy that routes inbound requests to existing HTTP backend services. Can be a JSON or XML API. See [Creating a reverse proxy for an HTTP service](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatingareverseproxyforanhttpservice) later in this section. Click **Use OpenAPI Spec** to generate the proxy from a valid OpenAPI Specification. For more informations on this option, see [Using OpenAPI Specifications to generate proxies](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#openapi) later in this section. |
| SOAP service | An API proxy generated from a WSDL file. See [Exposing a SOAP-based web service as an API proxy](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#exposingasoapbasedwebserviceasanapiproxy). |
| No target | An API proxy with no API backend ("no target"). Similar to [creating a reverse proxy for an HTTP service](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatingareverseproxyforanhttpservice) described previously, except you will not specify an existing API when defining the API proxy details. Click **Use OpenAPI Spec** to generate the proxy from a valid OpenAPI specification. For more informations on this option, see [Using OpenAPI Specifications to generate proxies](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#openapi) later in this section. |
| Hosted target | An API proxy that routes to a Node.js application that is deployed to the Hosted Targets environment. See [Hosted Targets overview](https://docs.apigee.com/api-platform/hosted-targets/hosted-targets-overview.md.txt). |
| Upload proxy bundle | An existing API proxy bundle (for example one of the [sample API proxies](https://github.com/apigee/api-platform-samples) available on GitHub.) See [Importing an API proxy from an API proxy bundle](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#importinganapiproxyfromanapiproxybundle). |

The following sections describe how to create an API proxy using each source.

## Creating a reverse proxy for an HTTP service

Edge generates reverse proxies based on two pieces of information:

- URL of the backend service
- URI path that uniquely identifies the API that will be exposed by the API proxy to consumer apps

The backend service URL typically represents a service-enabled application owned by your
organization. It can also point to a publicly available API. The API or service can be under your
control (for example, an internal HR application or a Rails application in the Cloud) or it can
be a third-party API or service (for example, Twitter or Instagram).

### Edge

1. Access the Create Proxy wizard, as described in [Creating an API proxy using the UI](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatinganapiproxyintheedgemanagementui) previously in this section.
2. In the Create Proxy wizard, click **Reverse proxy (most common)** . To generate the proxy from an existing, valid OpenAPI Specification, click **Use OpenAPI Spec** . For details on this option, see [Using OpenAPI Specifications to generate proxies](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#openapi) below.
3. On the **Details** page of the wizard, enter the following information.

   | Field | Description |
   |---|---|
   | Name | Name displayed for your API. Specify alphanumeric characters, dash (-), or underscore (_). |
   | Base path | URI fragment that appears after the http(s)://\[host\] address of your API proxy. Edge uses the base path URI to match and route incoming request messages to the proper API proxy. **NOTE** : The API proxy base path defaults to the value specified for the `Name` field converted to all lower case. Following the base path are any additional resource URLs. Here's the full URL structure that clients will use to call your API proxy: `https://[host]/base_path/conditional_flow_path` **NOTE**: The base path must be unique; you cannot deploy two API proxies with the same base path. If you edit a deployed API proxy and set the base path to the same value as the base path of another API proxy, Edge automatically undeploys the API proxy when you save it. Before you can redeploy the API proxy, you must edit the base path so that it is unique. **Use wildcards in base paths** Use one or more `/*/` wildcards in API proxy base paths to future-proof your API proxies. For example, a base path of `/team/*/members` allows clients to call `https://[host]/team/blue/members` and `https://[host]/team/green/members` without you needing to create new API proxies to support new teams. Note that `/**/` is not supported. |
   | Description | (Optional) Description of the API. |
   | Target (Existing API) | URL of the backend service that this API proxy invokes. |

4. On the **Common policies** page of the wizard, configure the following:
   - Security authorization requirements under **Security: Authorization** . See [Adding security](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#addingsecurityandcorssupporttoyourapi-addingsecurity) later in this section.
   - Support for Cross-origin resource sharing (CORS) under **Security: Browser** . See [Adding support for CORS](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#addingsecurityandcorssupporttoyourapi-addingsupportforcors) later in this section.
   - Quotas to protect your backend service from high traffic under **Quota** . See [Quotas](https://docs.apigee.com/api-platform/publish/what-api-product.md.txt#quotas). (Not available if Pass-through authorization is selected.)
   - Monetization limit enforcement for monetization-enabled organizations under **Monetization** . See [Enforce monetization limits on API proxies](https://docs.apigee.com/api-platform/monetization/enforce-monetization-limits-using-monetization-limits-check-policy.md.txt).
5. On the **Virtual hosts** page of the wizard, select the virtual hosts the API proxy will bind to when deployed. For more information, see [About virtual hosts](https://docs.apigee.com/api-platform/fundamentals/virtual-hosts.md.txt).
6. On the **Summary** page, select the deployment environment(s), if desired, and click **Create and deploy** .

   Your new API proxy is created
   and deployed in the selected environment.
7. Click **Edit proxy** to display the details page for the API proxy.

### New Edge UI (Private Cloud)

> [!NOTE]
> **Note:** The New Edge UI is available with Edge for Private Cloud only.

1. Access the Create Proxy wizard, as described in [Creating an API proxy using the UI](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatinganapiproxyintheedgemanagementui) previously in this section.
2. In the Create Proxy wizard, click **Reverse proxy (most common)** . To generate the proxy from an existing, valid OpenAPI Specification, click **Use OpenAPI Spec** . For details on this option, see [Using OpenAPI Specifications to generate proxies](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#openapi) below.
3. On the **Details** page of the wizard, enter the following information.

   | Field | Description |
   |---|---|
   | Name | Name displayed for your API. Specify alphanumeric characters, dash (-), or underscore (_). |
   | Base path | URI fragment that appears after the http(s)://\[host\] address of your API proxy. Edge uses the base path URI to match and route incoming request messages to the proper API proxy. **NOTE** : The API proxy base path defaults to the value specified for the `Name` field converted to all lower case. Following the base path are any additional resource URLs. Here's the full URL structure that clients will use to call your API proxy: `https://[host]/base_path/conditional_flow_path` **NOTE**: The base path must be unique; you cannot deploy two API proxies with the same base path. If you edit a deployed API proxy and set the base path to the same value as the base path of another API proxy, Edge automatically undeploys the API proxy when you save it. Before you can redeploy the API proxy, you must edit the base path so that it is unique. **Use wildcards in base paths** Use one or more `/*/` wildcards in API proxy base paths to future-proof your API proxies. For example, a base path of `/team/*/members` allows clients to call `https://[host]/team/blue/members` and `https://[host]/team/green/members` without you needing to create new API proxies to support new teams. Note that `/**/` is not supported. |
   | Description | (Optional) Description of the API. |
   | Target (Existing API) | URL of the backend service that this API proxy invokes. |

4. On the **Common policies** page of the wizard, configure the following:
   - Security authorization requirements under **Security: Authorization** . See [Adding security](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#addingsecurityandcorssupporttoyourapi-addingsecurity) later in this section.
   - Support for Cross-origin resource sharing (CORS) under **Security: Browser** . See [Adding support for CORS](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#addingsecurityandcorssupporttoyourapi-addingsupportforcors) later in this section.
   - Quotas to protect your backend service from high traffic under **Quota** . See [Quotas](https://docs.apigee.com/api-platform/publish/what-api-product.md.txt#quotas). (Not available if Pass-through authorization is selected.)
   - Monetization limit enforcement for monetization-enabled organizations under **Monetization** . See [Enforce monetization limits on API proxies](https://docs.apigee.com/api-platform/monetization/enforce-monetization-limits-using-monetization-limits-check-policy.md.txt).
5. On the **Virtual hosts** page of the wizard, select the virtual hosts the API proxy will bind to when deployed. For more information, see [About virtual hosts](https://docs.apigee.com/api-platform/fundamentals/virtual-hosts.md.txt).
6. On the **Summary** page, select the deployment environment(s), if desired, and click **Create and deploy** .

   Your new API proxy is created and deployed in the selected environment.
7. Click **Edit proxy** to display the details page for the API proxy.

## Importing an API proxy from an API proxy
bundle

> [!NOTE]
> **Note:** When importing an API proxy from an API proxy bundle, you are responsible for configuring security in and adding policies to the bundle. The UI does not prompt you to add security or policies when importing the bundle, as described in [Adding security](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#addingsecurityandcorssupporttoyourapi-addingsecurity) later in this section.

Often you define API proxies as a collection of XML files, along with any other
supporting files. By defining your API proxies as a set of files external to Edge you can
maintain them in a source-control system, and then import them into Edge for testing and
deployment.

> [!NOTE]
> Apigee provides a set of API proxy samples as bundles on GitHub that you can download, examine, modify, and import to Edge. See [Using the sample API proxies](https://docs.apigee.com/api-platform/samples/using-samples.md.txt).

Watch this video to learn how to create and import an API proxy from an API proxy
bundle.
<iframe allowfullscreen frameborder="0" height="315" src="https://www.youtube.com/embed/sruxgYQlc2M" width="560"></iframe>

### Edge

To import API proxies from an API proxy bundle:

1. Access the Create Proxy wizard, as described in [Creating an API proxy using the UI](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatinganapiproxyintheedgemanagementui) previously in this section.
2. Click **Upload proxy bundle**.
3. On the **Upload proxy bundle** page in the proxy wizard, enter the following information.  

   | Field | Description |
   |---|---|
   | ZIP bundle | ZIP file containing the API proxy configuration. Drag and drop or click to navigate to the file. |
   | Name | Name displayed for your API. Defaults to the name of the ZIP file without the extension. |

4. Click **Next**.
5. On the **Summary** page, select the deployment environment(s), if desired, and click **Create and deploy**   
   An acknowledgment is displayed confirming that your new API proxy was successfully created.
6. Click **Edit proxy** to display the details page for the API proxy.

### New Edge UI (Private Cloud)

> [!NOTE]
> **Note:** The New Edge UI is available with Edge for Private Cloud only.

To import API proxies from an API proxy bundle:

1. Access the Create Proxy wizard, as described in [Creating an API proxy using the UI](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#creatinganapiproxyintheedgemanagementui) previously in this section.
2. Click **Upload proxy bundle**.
3. On the **Upload proxy bundle** page in the proxy wizard, enter the following information.  

   | Field | Description |
   |---|---|
   | ZIP bundle | ZIP file containing the API proxy configuration. Drag and drop or click to navigate to the file. |
   | Name | Name displayed for your API. Defaults to the name of the ZIP file without the extension. |

4. Click **Next**.
5. On the **Summary** page, select the deployment environment(s), if desired, and click **Create and deploy** .  
   An acknowledgment is displayed confirming that your new API proxy was successfully created.
6. Click **Edit proxy** to display the details page for the API proxy.

## Exposing a SOAP-based web service as an API
proxy

In the Create Proxy wizard, click **SOAP Service** , and follow the wizard to
create a pass-through or REST-based proxy for a SOAP service. For details, see [Exposing
a SOAP service as an API proxy](https://docs.apigee.com/api-platform/develop/exposing-soap-service-api-proxy).

## Adding security

On the **Common policies** page of the Create Proxy wizard, select the type of security authorization you wish to add. The following table summarizes the available options:

| Security authorization | Description |
|---|---|
| API Key | Adds simple API key verification to the API proxy that you are defining. In response, the API Platform adds a VerifyAPIKey policy and an AssignMessage policy to your API proxy. The VerifyAPIKey policy validates API keys presented by requesting apps. The AssignMessage policy strips the API key, supplied in the API call as a query parameter, from the request forwarded to the backend server. |
| OAuth 2.0 | Adds OAuth 2.0 based authentication to your API proxy. Apigee Edge automatically adds two policies to your API proxy: one policy to verify an access token and another policy to strip the access token from the message before forwarding it to your backend service. To learn how to obtain an access token, see [OAuth](https://docs.apigee.com/api-platform/security/oauth/oauth.md.txt). |
| Pass through (no authorization) | No authorization required. Requests are passed to the backend without any security checks on Apigee Edge. |

## Adding support for CORS

CORS (Cross-origin resource sharing) is a standard mechanism that allows a Web browser to make
direct requests to another domain. The CORS standard defines a set of HTTP headers that Web
browsers and servers use to implement cross-domain communication.

You can add support for CORS to your API by selecting **Add CORS headers** on the
**Common policies** page of the Create Proxy wizard.

For more detailed information about CORS support, including adding CORS preflight support
to a proxy, see [Adding CORS
support to an API proxy](https://docs.apigee.com/api-platform/develop/adding-cors-support-api-proxy).

## Using OpenAPI Specifications to generate proxies

This section discusses the Use OpenAPI option that is available for generating from an OpenAPI
Specification the following types of API proxies: reverse, Node.js, or no target.

### What is an
OpenAPI Specification?

![Open API Initiative logo](https://docs.apigee.com/static/api-platform/images/OpenAPI_Pantone.png)"The Open API Initiative (OAI) is focused on
creating, evolving and promoting a vendor neutral API Description Format based on the Swagger
Specification." For more information about the Open API Initiative, see <https://openapis.org>.

An *OpenAPI Specification* uses a standard format to describe a RESTful API.
Written in either JSON or YAML format, an OpenAPI Specification is machine readable, but is also
easy for humans to read and understand. The specification describes such elements of an API as
its base path, paths and verbs, headers, query parameters, operations, content types, response
descriptions, and more. In addition, an OpenAPI Specification is commonly used to generate API
documentation.

Here's a fragment from an OpenAPI Specification that describes Apigee's mock target service,
[http://mocktarget.apigee.net](https://mocktarget.apigee.net). For
more information, see <https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi>.

```
openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
  /help:
    get:
      summary: Get help
      operationId: Get help
      description: View help information about available resources in HTML format.
      responses:
        "200":
          description: Success
...
```

Through the Create Proxy wizard, you can import an OpenAPI Specification and use it to
generate an API proxy. Once the proxy is generated, you can use the Edge UI to further develop it
by adding policies, implementing custom code, and so on -- just like any Edge proxy.

### Creating an API proxy from an OpenAPI Specification


Create your API proxies from an OpenAPI Specification.
In just a few clicks, you'll have an API proxy with the paths, parameters, conditional flows, and target endpoints generated automatically. Then, you can add features such as OAuth security, rate limiting, and caching.

In the Create Proxy wizard, click **Use OpenAPI Spec** and follow the wizard to create a reverse or no target proxy from an OpenAPI Specification. For details, see [Create an API proxy
from an OpenAPI Specification](https://docs.apigee.com/api-platform/tutorials/create-api-proxy-openapi-spec).
Watch this video to learn how to create an API proxy from an OpenAPI Specification.
<iframe allowfullscreen frameborder="0" height="315" src="https://www.youtube.com/embed/3XBG9QOUPzg" width="560"></iframe>

### Updating the flows in an API proxy using an OpenAPI Specification


After you create an API proxy from an OpenAPI Specification, if you modify the specification to add additional resource paths you can use the specification to add the associated conditional flows to the API proxy.

To update the flows in an API proxy using an OpenAPI Specification:

1. Add the new resource paths to the OpenAPI Specification. See [Editing an existing OpenAPI Specification](https://docs.apigee.com/api-platform/publish/specs/manage-specs.md.txt#edit-spec).
2. Open the API Proxy in the UI and click the **Develop** tab.
3. In the Navigator, click **+** next to the Proxy endpoint that you want to update.  
   The New Conditional Flow dialog box opens.
4. Click **From OpenAPI** if it is not already selected.  
   If there are resources in the OpenAPI Specification that do not have a corresponding conditional flow in the API proxy, they are listed in the dialog, as shown in the following figure. ![Resources that are not respresented as flows in the current API proxy. This example includes /loveapis, /ip, /json, and /xml.](https://docs.apigee.com/static/api-platform/images/add-conditional-flow.png)
5. Select each of the resources for which you want to add a conditional flow.
6. Click **Add**.

The conditional flows are added to your API proxy.

## Creating a new revision of an API proxy

Create a new revision of an API proxy, as described below.

### Edge

To create a new revision of an API proxy using the Edge UI:

1. Sign in to [apigee.com/edge](https://apigee.com/edge).
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click the API proxy in the list that you want to copy.
4. Select **Project \> Save as New Revision**.

### New Edge UI (Private Cloud)

> [!NOTE]
> **Note:** The New Edge UI is available with Edge for Private Cloud only.

To create a new revision of an API proxy using the New Edge UI:

1. Sign in to the New Edge UI at `http://host:3001/edge`, where <var translate="no">host</var> is the IP address or DNS name of the host running the New Edge UI.
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click the API proxy in the list that you want to copy.
4. Select **Project \> Save as New Revision**.

## Copying an API proxy

Copy an existing API proxy to a new API proxy, as described below.

### Edge

To copy an API proxy using the Edge UI:

1. Sign in to [apigee.com/edge](https://apigee.com/edge).
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click the API proxy in the list that you want to copy.
4. Select **Project \> Save as New API Proxy**.
5. In the Save as New Proxy dialog, enter the name of the new API proxy.
6. Click **Add**.

### New Edge UI (Private Cloud)

> [!NOTE]
> **Note:** The New Edge UI is available with Edge for Private Cloud only.

To copy an API proxy using the New Edge UI:

1. Sign in to the New Edge UI at `http://host:3001/edge`, where <var translate="no">host</var> is the IP address or DNS name of the host running the New Edge UI.
2. Select **Develop \> API Proxies** in the left navigation bar.
3. Click the API proxy in the list that you want to copy.
4. Select **Project \> Save as New API Proxy**.
5. In the Save as New Proxy dialog, enter the name of the new API proxy.
6. Click **Add**.

## Backing up an API proxy


You can back up an existing API proxy as a set of XML files in an API proxy bundle. Once exported to a bundle, you can import the API proxy
to a new proxy, as described in [Importing an API proxy from an API proxy bundle](https://docs.apigee.com/api-platform/fundamentals/build-simple-api-proxy.md.txt#importinganapiproxyfromanapiproxybundle) previously in this section. For more information, see [Download API proxies](https://docs.apigee.com/api-platform/fundamentals/download-api-proxies.md.txt).

## Creating an API proxy using the API

To create an API proxy using the API, see [API proxies API](https://docs-edgeapis.apigee.io/docs/api-proxies/1/overview).