Was this helpful?


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

API Resource Path:


Description: Creates an app for a company

Verb: POST
Auth: Basic Auth
Media types:


Apps that are registered on Apigee Edge can be associated with individual developers or with companies.

Use this API call to create an app that is associated with a company. Note that you must first create a profile for the company in your organization before you can register apps that are associated with the company.

Sample Request:
$ curl -H "Content-type:application/json" -X POST -d \
  "accessType" : "read",
  "attributes" : [ {
    "name" : "Language",
    "value" : "java"
  } ],
  "apiProducts": [ "TestApiProduct"],
  "callbackUrl" : "www.apigee.com",
  "name" : "sandboxTestApp"
}' \
https://api.enterprise.apigee.com/v1/o/{org_name}/companies/{company_name}/apps \
-u myname:mypass

Request Payload Elements:

Name Description Default Required?
accessType Access type for the app (unused by Apigee)   No
attributes Name/value formatted attributes used to extend the default profile   No
apiProducts Any API Products the app consumes   No
name The name of the app. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %. For example, Cat2 %_ is a legal name.   Yes
callbackUrl A URL used for OAuth-related redirects. The domain defined in the callbackURL must match the domain to which users are redirected after authentication..   Yes

Sample Response:

  "accessType" : "read",
  "attributes" : [ {
    "name" : "Language",
    "value" : "java"
  } ],
  "callbackUrl" : "www.apigee.com",
  "createdAt" : 1343050516114,
  "createdBy" : "Admin",
  "credentials" : [ {
    "apiProducts" : [ {
      "apiproduct" : "TestApiProduct",
      "status" : "approved"
    } ],
    "attributes" : [ ],
    "consumerKey" : "N6S0jcOhgbsCJD3B7EGNFo0FYAZSpCez",
    "consumerSecret" : "BCJpVuK3uq9VuEgK",
    "status" : "approved"
  } ],
  "lastModifiedAt" : 1343050516114,
  "lastModifiedBy" : "Admin",
  "name" : "sandboxTestApp",
  "status" : "approved"

Response Payload Elements:

Name Description
attributes Name/value pairs used to extend the default profile
callbackUrl If set, the Oauth policy will not provide an access token unless the redirect_uri in the request matches the value of the callback in the app
createdAt Unix time when the app was created
createdBy User name of the Apigee developer who created the app
credentials A set of credentials for the app--credentials are app key/secret pairs associated with API products
apiProducts A list of API products with which the app is associated
apiproduct Name of the API product
status The status of the association between the API product and the consumer key: 'approved' or 'unapproved'
attributes Name/value pairs used to extend the default profile
consumerKey The value of the consumer key
consumerSecret The value of the consumer secret associated with the consumer key
status The status of the consumer key: 'approved' or 'pending'
lastModifiedAt Unix time when the app was last modified
lastModifiedBy User name of teh Apigee user who last modified the app
name Name of the app
status Status of the app: 'approved' or 'unapproved'


  "code" : "keymanagement.service.app_invalid_name",
  "message" : "Invalid App Name",
  "contexts" : [ ]


Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)