Was this helpful?


Apigee Edge Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path:


Description: Creates an API facade (and an API proxy configuration) on Apigee Edge.

Verb: POST
Auth: Basic Auth
Media types:

For detailed instructions on API proxy development, see the Build APIs section.


This method creates an API proxy in an Apigee Edge organization.

The API proxy that is created using this call will not be accessible at runtime until the proxy is deployed to an environment.

Usually, this request is followed up with an export API proxy method call, which exports the API proxy bundle to the developer's local machine for development.

API proxies can also be created and deployed using the Apigee Edge Management User Interface. Sample Request:
$ curl -H "Content-type:application/json" -X POST -d \
'{"name" : "myAPI"}'  \
https://api.enterprise.apigee.com/v1/o/{org_name}/apis \
-u myname:mypass
Request Payload Elements:
Name Description Default Required?
name The name of the API N/A Yes
Sample Response:
    "configurationVersion": {
        "majorVersion": 4, 
        "minorVersion": 0
    "contextInfo": "Revision 1 of application weatherTest, in organization apiProvider", 
    "createdAt": 1343182801400, 
    "createdBy": "admin@apigee.com", 
    "lastModifiedAt": 1343182801400, 
    "lastModifiedBy": "admin@apigee.com", 
    "name": "myAPI", 
    "policies": [], 
    "proxyEndpoints": [], 
    "resources": [], 
    "revision": "1", 
    "targetEndpoints": [], 
    "targetServers": [], 
    "type": "Application"
Response Payload Elements:
Name Description
configurationVersion The version of Apigee that the configuration is valid for
contextInfo Apigee generated contextual information about the entity
name The name of the API
policies Policies attached to the API
proxyEndpoints Named proxy endpoints (receiver) defined for the API proxy
resources Any code, scripts, XSLT files used by policies attached to this API
revision The sequential numbered packages of code and configuration that make up an API proxy
targetEndpoints Named proxy endpoints (sender) defined for the API proxy
targetServers Target servers defined for load balancing purposes
type Internal entity definition used by Apigee


Add new comment

Provide your email address if you wish to be contacted offline about your comment.
We will not display your email address as part of your comment.

We'd love your feedback and perspective! Please be as specific as possible.
Type the characters you see in this picture. (verify using audio)

Type the characters you see in the picture above; if you can't read them, submit the form and a new image will be generated. Not case sensitive.