API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
Analytics | Resource Detail | |||
| Analytics reports based on runtime metrics collected by the API Platform that measure API consumption and performance | ||||
Resource path: /environments/{env_name}/stats | ||||
| URI | Verb | Content Types | Action | |
/environments/{environment_name}/stats/{dimension_name} |
GET |
application/json
|
Get an analytics report for a dimension | Detail |
API Products | Resource Detail | |||
| Bundled URIs combined with rate limit settings and developer-defined metadata that enable OAuth-based runtime authorization to API resources | ||||
Resource path: /apiproducts | ||||
| URI | Verb | Content Types | Action | |
/apiproducts |
POST |
application/json
text/xml
|
Create an API product | Detail |
/apiproducts/{apiproduct_name} |
DELETE | Delete an API product | Detail | |
/apiproducts/{apiproduct_name} |
GET | Get an API product | Detail | |
/apiproducts/{apiproductName}?query=count&entity={entity_name} |
GET | Get count of keys, apps, developers, or companies for an API product | Detail | |
/apiproducts/{apiproduct_name}?query=list&entity={entity_name} |
GET | Get list of keys, apps, developers, or companies for an API product | Detail | |
/apiproducts |
GET |
application/json
text/xml
|
List API Products | Detail |
/apiproducts |
GET |
application/json
text/xml
|
Search API Products | Detail |
/apiproducts/{apiproduct_name} |
PUT |
application/json
text/xml
|
Update API Product | Detail |
APIs | Resource Detail | |||
| API facades that act as managed proxies for backend services | ||||
Resource path: /apis | ||||
| URI | Verb | Content Types | Action | |
/apis |
POST |
application/json
text/xml
|
Create an API | Detail |
/apis/{api_name} |
DELETE | Delete an API | Detail | |
/apis/{api_name}/revision/{revision_number} |
DELETE | Delete an API Revision | Detail | |
/apis/{api_name}/revisions/{revision_number}/deployments?action=deploy&env={environment_name}&basepath={/basepath} |
POST | Deploy an API to an Environment | Detail | |
/apis/{api_name}/revisions{revision_number}?format=bundle |
GET | Export an API | Detail | |
/apis/{api_name} |
GET | Get an API | Detail | |
/apis?action=import&name={api_name} |
POST | Import an API | Detail | |
/apis |
GET | List APIs | Detail | |
/apis/{api_name}/deployments?action=undeploy&env={environment_name}&revision={revision_number} |
POST | Undeploy an API from an Environment | Detail | |
/apis/{api_name} |
PUT |
application/json
text/xml
|
Update an API | Detail |
App Families | Resource Detail | |||
| App collections, associated with individual developers, that enable aggregate management of app instances. | ||||
Resource path: /developers/{developer_email}/appfamilies | ||||
| URI | Verb | Content Types | Action | |
/developers/{developer_email}/appfamilies |
POST | Create an app family | Detail | |
/developers/{developer_email}/appfamilies/{app_family} |
DELETE | Delete an app family | Detail | |
/developers/{developer_email}/appfamilies/{app_family} |
GET | Get an app family | Detail | |
/developers/{developer_ email}/app_families |
GET | List all app families in an organization | Detail | |
/developers/{developer_email}/app_families?expand=true |
GET | List app families (detailed view) | Detail | |
/developers/{developer_email}/appfamilies/{app_family}/app/{app_name} |
DELETE | Remove an app from an app family | Detail | |
/developers/{developer_email}/appfamilies/{appfamily_name} |
POST | Update an app family | Detail | |
Apps | Resource Detail | |||
| Client/consumer applications (apps) registered by developers or companies in an organization on the API Platform to consume provider APIs | ||||
Resource path: /apps | ||||
| URI | Verb | Content Types | Action | |
/apps/{app_id} |
GET |
application/json
text/xml
|
Get an app profile | Detail |
/apps?appfamily={app_family} |
GET | Get apps by app family | Detail | |
/apps?status={status} |
GET | Get apps by status | Detail | |
/apps?apptype={app_type} |
GET | Get apps by type | Detail | |
/apps?createdat={created_at} |
GET | List apps by creation date | Detail | |
/apps |
GET | List apps in an organization | Detail | |
Apps: Company | Resource Detail | |||
| A consumer/client app associated with a company entity. | ||||
Resource path: /companies/{company_name}/apps | ||||
| URI | Verb | Content Types | Action | |
/companies/{company_name}/apps |
POST | Create app for a company | Detail | |
/companies/{company_name}/apps/{app_name} |
DELETE | Delete a company app | Detail | |
/companies/{companyName}/apps/{appname}?query=count&entity=apiresources |
GET | Get count of API Resources for Company App | Detail | |
/companies/{company_name}/apps |
GET | List company apps | Detail | |
/companies/{company_name}/apps?expand=true |
GET | List Company Apps (Expanded) | Detail | |
/companies/{company_name}/apps/{app_name} |
PUT | Update a Company App | Detail | |
/companies/{company_name}/apps/{app_name}/keys/{consumer_key} |
POST |
application/json
text/xml
|
Update a company app with an additional API product | Detail |
/companies/{company_name}/apps/{app_name} |
PUT | Update Company App | Detail | |
Apps: Developer | Resource Detail | |||
| A client/consumer app associated with a developer entity | ||||
Resource path: /developers/{developer_email}/apps | ||||
| URI | Verb | Content Types | Action | |
/developers/{developer_email}/apps/{app_name} |
GET | Approve a developer app | Detail | |
/developers/{developer_email}/apps |
POST | Create a Developer App | Detail | |
/developers/{developer_email}/apps/{app_name} |
DELETE | Delete a Developer App | Detail | |
/developers/{developer_email}/apps/{app_name} |
GET | Get a Developer App | Detail | |
/developers/{developer_email}/apps/{app_name}?"query=count&entity={entity_name}" |
GET | Gets the count of API resources defined in API products approved for a developer app in an organization | Detail | |
/developers/{developer_email}/apps |
GET | List Apps by Developer | Detail | |
/developers/{developer_email}/apps?expand=true |
GET | List Developer Apps (Expanded) | Detail | |
/developers/{developer_email}/apps/{app_name}?action=revoke |
POST |
application/x-www-url-form-encoded
|
Revoke a Developer App | Detail |
/developers/{developer_email}/apps/{app_name} |
PUT | Update a developer app | Detail | |
Audits | Resource Detail | |||
| Events stored as log entries in the API Platform datastore. (Note that the base path for audits precedes /organizations.) | ||||
Resource path: /audits | ||||
| URI | Verb | Content Types | Action | |
/audits |
GET |
application/json
text/xml
|
Get audit logs | Detail |
/users/{user_email}/audits |
GET |
application/json
text/xml
|
Lists audit entries for a user in an organization | Detail |
Companies | Resource Detail | |||
| An optional grouping entity for apps, which enables corporate entities or groups of developers to manage apps. | ||||
Resource path: /companies | ||||
| URI | Verb | Content Types | Action | |
/companies |
POST | Create a company | Detail | |
/companies/{company_name} |
DELETE | Delete a company | Detail | |
/companies/{company_name} |
GET | Get details for a company | Detail | |
/companies |
GET | List companies | Detail | |
/companies?expand=true |
GET | List companies in an organization (detailed view) | Detail | |
/companies/{company_name}/appfamilies |
GET | List company app families | Detail | |
/companies/{company_name} |
POST | Update a company | Detail | |
Company App Keys | Resource Detail | |||
| Consumer credentials (also known as "API keys" or "app keys") generated, provisioned, and managed by the API Platform for apps associated with company entities. | ||||
Resource path: /companies/{company_name}/apps/{app_name}/keys | ||||
| URI | Verb | Content Types | Action | |
/companies/{company_name}/apps/{app_name}/keys/{consumer_key}?action=approve |
POST |
application/json
text/xml
|
Approve a company app key | Detail |
/companies/{company_name}/apps/{app_name}/keys/{consumer_key} |
DELETE | Delete a company app key | Detail | |
/companies/{company_name}/apps/{app_name}/keys/{consumer_key} |
GET | Get a specific key of company app | Detail | |
companies/{company_name}/apps/{app_name}/keys/{consumer_key}?action=revoke |
POST | Revoke a company app key | Detail | |
/companies/{company_name}/apps/{app_ame}/keys/{consumer key} |
POST | Update existing app key with new API product(s). | Detail | |
Company Developers | Resource Detail | |||
| A collection of developers associated with a company entity. | ||||
Resource path: /companies/{company_name}/developers | ||||
| URI | Verb | Content Types | Action | |
/companies/{company_name}/developers |
POST |
application/json
text/xml
|
Add a company developer | Detail |
/companies/{company_name}/developers/{developer_email} |
DELETE | Delete a developer association with a company | Detail | |
/companies/{company_name}/developers/ |
GET | List Developers in a Company | Detail | |
Debug Sessions | Resource Detail | |||
| A session configured on the API Platform to record specified messages and associated pipeline processing metadata for debugging purposes | ||||
Resource path: /debugsessions | ||||
| URI | Verb | Content Types | Action | |
/environments/{env_name} /apis/{api_name}/revisions/{revision_number}/debugsessions |
POST |
application/x-www-url-form-encoded
|
Create Debug Session | Detail |
/environments/{environmentName}/apis/{apiName}/revisions/{revisionVersion}/debugsessions/{sessionID} |
DELETE | Delete a debug session | Detail | |
/environments/{environmentName}/apis/{apiName}/revisions/{revisionId/debugsessions/{debugSessionId}/data |
GET | Get Debug Session Data | Detail | |
/environment/{environmentName}/debugsessions |
GET | List Debug Sessions | Detail | |
Deployments | Resource Detail | |||
| APIs actively deployed in environments on the API Platform | ||||
Resource path: /apis/{api_name}/deployments | ||||
| URI | Verb | Content Types | Action | |
/apis/{api_name}/deployments |
GET | Get API deployments | Detail | |
/apis/{api_name}/revisions/{revision_number}/deployments |
GET | Get API Revision Deployments | Detail | |
/environments/{environment_name}/deployments |
GET | Get Deployments for an Environment | Detail | |
/deployments |
GET | Get Deployments for an Organization | Detail | |
Developer App Keys | Resource Detail | |||
| Consumer credentials (also known as "API keys" or "app keys") generated, provisioned, and managed by the API Platform for apps associated with individual developers. | ||||
Resource path: /developers/{developer_email}/apps/{app_name}/keys | ||||
| URI | Verb | Content Types | Action | |
/developers/{developer_emal}/apps/{app_name}/keys/{consumer_key} |
POST |
application/x-www-url-form-encoded
|
Approve a developer app key | Detail |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name} |
POST | Approve API Product for the Key of Developer App | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} |
DELETE | Delete a Developer App Key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name} |
DELETE |
application/json
text/xml
|
Delete API product from a developer app key profile | Detail |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} |
GET | Get a specific Key of Developer App | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} |
POST | Revoke a Developer App Key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key}/apiproducts/{apiproduct_name}?action=revoke |
POST | Revoke API product association with a specific developer app key | Detail | |
/developers/{developer_email}/apps/{app_name}/keys/{consumer_key} |
POST | Update Key with ApiProduct(s) | Detail | |
Developers | Resource Detail | |||
| Developers who implement client/consumer apps and are registered with an organization on the API Platform. | ||||
Resource path: /developers | ||||
| URI | Verb | Content Types | Action | |
/developers |
POST | Create a Developer | Detail | |
/developers/{developer_email} |
DELETE | Delete a Developer | Detail | |
/developers/developer_email} |
GET | Get a Developer | Detail | |
/developers?app={app_name} |
GET | Get Developer of an App | Detail | |
/developers |
GET | List Developers | Detail | |
/developers/{developer_email} |
PUT | Update a Developer | Detail | |
Environments | Resource Detail | |||
| Network-accessible runtime deployment containers (typically named 'test' and 'prod') available for APIs on the API Platform. | ||||
Resource path: /environments | ||||
| URI | Verb | Content Types | Action | |
/environments/{environment_name} |
GET | Get Environment | Detail | |
/environments |
GET | List Environments | Detail | |
Key/Value Maps | Resource Detail | |||
| Persistence resources that enable storing arbitrary data | ||||
Resource path: /keyvaluemaps | ||||
| URI | Verb | Content Types | Action | |
/keyvaluemaps |
POST |
application/json
text/xml
|
Create KeyValueMap | Detail |
/keyvaluemaps/{map_name}/entries/{entry_name} |
DELETE |
application/json
text/xml
|
Delete Entry | Detail |
/keyvaluemaps/{map_name} |
DELETE |
application/json
text/xml
|
Delete KeyValueMap | Detail |
/keyvaluemaps/{map_name} |
GET |
application/json
text/xml
|
Get KeyValueMap | Detail |
/keyvaluemaps?expand=true |
GET |
application/json
text/xml
|
Get list of KeyValueMaps (Expanded) | Detail |
/keyvaluemaps |
GET |
application/json
text/xml
|
List KeyValueMaps | Detail |
/keyvaluemaps/{map_name} |
POST |
application/json
text/xml
|
Update KeyValueMap | Detail |
OAuth 1.0a Access Tokens | Resource Detail | |||
| Oauth 1.0a Access Tokens | ||||
Resource path: /oauth1/accesstokens | ||||
| URI | Verb | Content Types | Action | |
/oauth1/accesstokens/{access_token}?action=approve |
POST | Approve Oauth 1.0 Access Token | Detail | |
/oauth1/accesstokens/{access_token} |
DELETE | Delete Oauth 1.0 Access Token | Detail | |
/oauth1/accesstokens |
GET | Get count of Oauth 1.0 Access Tokens | Detail | |
/oauth1/accesstokens/{access_token} |
GET | Get Oauth 1.0 Access Token | Detail | |
/oauth1/accesstokens/{access_token}?action=revoke |
POST |
application/x-www-url-form-encoded
|
Revoke Oauth 1.0 Access Token | Detail |
/oauth1/accesstokens/{access_token} |
POST | Update Oauth 1.0 Access Token | Detail | |
OAuth 1.0a Request Tokens | Resource Detail | |||
| OAuth 1.0a Request Tokens | ||||
Resource path: /oauth1/requesttokens | ||||
| URI | Verb | Content Types | Action | |
/oauth1/requesttokens/{request_token}?action=approve |
POST | Approve a Request Token | Detail | |
/oauth1/requesttokens/{request_token} |
DELETE | Delete a Request Token | Detail | |
/oauth1/requesttokens/{request_token}?consumerKey={consumer_key} |
GET | Get an Oauth 1.0a Request Token | Detail | |
/oauth1/requesttokens |
GET | List Request Tokens | Detail | |
/oauth1/requesttokens/{request_token}?action=revoke |
POST | Revoke a Request Token | Detail | |
/oauth1/requesttokens/{request_token} |
PUT | Update a Request Token | Detail | |
OAuth 1.0a Verifiers | Resource Detail | |||
| OAuth 1.0a Verifiers | ||||
Resource path: /oauth1/verifiers | ||||
| URI | Verb | Content Types | Action | |
/oauth1/verifiers/{verifier_code} |
DELETE | Delete OAuth 1.0 Verifier | Detail | |
/oauth1/verifiers/{verifier_code} |
GET | Get an OAuth 1.0 Verifier | Detail | |
/oauth1/verifiers |
GET | List OAuth 1.0 Verifiers | Detail | |
Oauth 2.0 Access Tokens | Resource Detail | |||
| OAuth 2.0-compliant access tokens generated, managed, and validated by the API Platform | ||||
Resource path: /oauth2/accesstokens | ||||
| URI | Verb | Content Types | Action | |
/oauth2/accesstokens/{access_token}?action=approve |
GET | Approve an Access Token | Detail | |
/oauth2/accesstokens/{access_token} |
DELETE | Delete an Access Token | Detail | |
/oauth2/accesstokens/{access_token} |
GET | Get an Access Token | Detail | |
/oauth2/accesstokens |
GET | Get count of AccessTokens | Detail | |
/oauth2/accesstokens/{access_token}?action=revoke |
POST | Revoke an Access Token | Detail | |
/oauth2/accesstokens/{access_token} |
POST |
application/json
text/xml
|
Update Access Token | Detail |
Oauth 2.0 Authorization Code | Resource Detail | |||
| Oauth 2.0-compliant authorization codes generated, managed, and validated by the API Platform | ||||
Resource path: /oauth2/authorizationcodes | ||||
| URI | Verb | Content Types | Action | |
/oauth2/authorizationcodes/{authorization_code} |
DELETE | Delete Authorization Code | Detail | |
/oauth2/authorizationcodes/{authorization_code} |
GET | Get Authorization Code | Detail | |
/oauth2/authorizationcodes |
GET | List Authorization Codes | Detail | |
Organizations | Resource Detail | |||
| The base account structure for the API Platform, an organization is a container for all managed entities, including APIs, API products, developers, apps, environments, etc. | ||||
Resource path: /organizations | ||||
| URI | Verb | Content Types | Action | |
/organizations{org_name} or /o/{org_name} |
GET | Get Organization | Detail | |
RBAC Resources | Resource Detail | |||
| An entity in an organization that can be associated with permissions to enable role-based access control | ||||
Resource path: /resources | ||||
| URI | Verb | Content Types | Action | |
/resources |
POST | Create a resource | Detail | |
/resources/?path={resource_name} |
DELETE | Delete a resource | Detail | |
/resources/{resource_name} |
GET | Get a resource | Detail | |
/resources |
GET | List resources | Detail | |
User roles | Resource Detail | |||
| Roles for users in an organization on the API Platform | ||||
Resource path: /userroles | ||||
| URI | Verb | Content Types | Action | |
/userroles/{role_name}/users?id={user_email} |
POST |
application/x-www-url-form-encoded
|
Add a user to a role | Detail |
/userroles/{role_name}/permissions |
POST | Add permissions for a resource to a user role | Detail | |
/userroles |
POST | Create a user role in an organization | Detail | |
/userroles/{role_name} |
DELETE | Delete a user role | Detail | |
/userroles/{role_name}/permissions/{permission_name}?path={resource_path} |
DELETE | Delete permission for a resource | Detail | |
/userroles/{role_name} |
GET | Get a role | Detail | |
/userroles/{role_name}/permissions |
GET | Get permissions for a resource | Detail | |
/userroles/{role_name}/permissions?path={resource_path} |
GET | Get resource permissions for a specific role | Detail | |
/userroles |
GET | Get user roles | Detail | |
/userroles/{role_name}/users |
GET | Get users for a role | Detail | |
/userroles/{role_name}/users/{user_email} |
DELETE | Remove user membership in role | Detail | |
/userroles/{role_name}/permissions/{permission_name}?path={resource_path} |
GET | Verify a user role's permission on a specific resource | Detail | |
/userroles/{role_rame}/users/{user_email} |
GET |
application/json
text/xml
|
Verify user role membership | Detail |
Users | Resource Detail | |||
| Users with an account in an organization on the Apigee API Platform | ||||
Resource path: /users | ||||
| URI | Verb | Content Types | Action | |
/users/{user_email}/userroles |
POST |
application/json
text/xml
|
Associate a user with a user role | Detail |
/users |
POST | Create a user | Detail | |
/users/{user_email} |
DELETE | Delete a user from an organization | Detail | |
/users/{user_email}/userroles/{role_name} |
DELETE | Delete role for user | Detail | |
/users/{user_email}/userroles |
GET | Get roles for a user | Detail | |
/users/{user_email} |
GET | Gets a user | Detail | |
/users |
GET | List users in an organization | Detail | |
/users/{user_email} |
POST |
application/json
text/xml
|
Update a user | Detail |
Virtual Hosts | Resource Detail | |||
| A named network configuration (including URL) for an environment (for example 'test' or 'prod') on the API Platform. | ||||
Resource path: /virtualhosts | ||||
| URI | Verb | Content Types | Action | |
/environments/{environment_name}/virtualhosts/{virtualhost_name} |
GET | Get a Virtual Host for an Environment | Detail | |
/environments/{environment_name}/virtualhosts |
GET | List Virtual Hosts for an Environment | Detail | |
