Analytics
Operation | Method | Path |
---|---|---|
Enable analytics for an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List analytics data export jobs | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an analytics data export job | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get status of an analytics export job | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an asynchronous analytics query in an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List asynchronous analytics queries in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the status of an asynchronous analytics query | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the results of an asynchronous analytics query | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Remove analytics information for an environment | delete | https://api.enterprise.apigee.com/analytics/groups/ax/{group_name}/scopes |
API Monitoring
Alerts | Collections | Logs | Metrics
API Monitoring: Alerts
Operation | Method | Path |
---|---|---|
List alerts | get | https://apimonitoring.enterprise.apigee.com/alerts |
Create an alert | post | https://apimonitoring.enterprise.apigee.com/alerts |
Get an alert | get | https://apimonitoring.enterprise.apigee.com/alerts/{alertId} |
Update an alert | put | https://apimonitoring.enterprise.apigee.com/alerts/{alertId} |
Delete an alert | delete | https://apimonitoring.enterprise.apigee.com/alerts/{alertId} |
API Monitoring: Collections
Operation | Method | Path |
---|---|---|
List collections | get | https://apimonitoring.enterprise.apigee.com/collections |
Create a collection | post | https://apimonitoring.enterprise.apigee.com/collections |
Get a collection | get | https://apimonitoring.enterprise.apigee.com/collections/{collection_id} |
Update a collection | patch | https://apimonitoring.enterprise.apigee.com/collections/{collection_id} |
Delete a collection | delete | https://apimonitoring.enterprise.apigee.com/collections/{collection_id} |
API Monitoring: Logs
Operation | Method | Path |
---|---|---|
Get traffic metrics | get | https://apimonitoring.enterprise.apigee.com/logs |
Get the list of API proxies associated with a specific virtual host and base path | get | https://apimonitoring.enterprise.apigee.com/logs/apiproxies |
API Monitoring: Metrics
Operation | Method | Path |
---|---|---|
Get alert history | get | https://apimonitoring.enterprise.apigee.com/metrics/alerthistory |
Get information about a triggered alert for an organization | get | https://apimonitoring.enterprise.apigee.com/metrics/alertinstance/{instance_id} |
Get the total count of alerts for an organization and time interval | get | https://apimonitoring.enterprise.apigee.com/metrics/alertsummary |
Gets all events in an organization for a specified time interval | get | https://apimonitoring.enterprise.apigee.com/metrics/events |
List available fault code categories | get | https://apimonitoring.enterprise.apigee.com/metrics/faultcodecategories |
List available fault codes with details | get | https://apimonitoring.enterprise.apigee.com/metrics/faultcodedetails |
List fault code names | get | https://apimonitoring.enterprise.apigee.com/metrics/faultcodenames |
List available fault code subcategories | get | https://apimonitoring.enterprise.apigee.com/metrics/faultcodesubcategories |
Get latency metrics for requests to Edge and to backend targets | get | https://apimonitoring.enterprise.apigee.com/metrics/latency |
List target domains for a specific organization and environment | get | https://apimonitoring.enterprise.apigee.com/metrics/targets |
Get traffic metrics | get | https://apimonitoring.enterprise.apigee.com/metrics/traffic |
API products
Operation | Method | Path |
---|---|---|
List API products | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an API product | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get an API product | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an API product | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API product | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List API product attributes | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update or create API product attributes | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get an API product attribute | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an API product attribute | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API product attribute | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
API proxies
Operation | Method | Path |
---|---|---|
ListAPI proxies | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an API Proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API proxy | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List revisions for an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get or export an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an existing revison of an API proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API proxy revision | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Gets npm dependencies for an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Run the specified npm command for an API proxy deployed on Edge | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
API security reports
Operation | Method | Path |
---|---|---|
Get information about a shared flow | get | https://apisecurity.enterprise.apigee.com/security/configuration/flow |
Get information about the API proxies deployed for a given organization and environment | get | https://apisecurity.enterprise.apigee.com/security/configuration/proxy |
Get information about shared flow connections with an API proxy | get | https://apisecurity.enterprise.apigee.com/security/configuration/proxy/flows |
Get policy information for an API proxy | get | https://apisecurity.enterprise.apigee.com/security/configuration/proxy/policies |
Get information about all shared flows deployed in an environment | get | https://apisecurity.enterprise.apigee.com/security/configuration/sharedflows |
Get information about a shared flow revision | get | https://apisecurity.enterprise.apigee.com/security/configuration/sharedflows/detail |
Get security information for configured API proxy targets | get | https://apisecurity.enterprise.apigee.com/security/configuration/targets |
Get fault code counts for selected time range | get | https://apisecurity.enterprise.apigee.com/security/overview/faultcode |
Get information about the policy usage for a given organization and environment | get | https://apisecurity.enterprise.apigee.com/security/overview/policies |
Get the overall traffic and count of active proxies for a given time range | get | https://apisecurity.enterprise.apigee.com/security/overview/proxies |
Get traffic for every region and environment combination | get | https://apisecurity.enterprise.apigee.com/security/overview/traffic/envbyregion |
Get traffic data by environment for a given time range | get | https://apisecurity.enterprise.apigee.com/security/overview/traffic/environments |
Get traffic information grouped by a given resource | get | https://apisecurity.enterprise.apigee.com/security/overview/traffic/resource |
Get total traffic in a time series | get | https://apisecurity.enterprise.apigee.com/security/overview/traffic/total |
Get traffic data aggregated by developer app in given time range | get | https://apisecurity.enterprise.apigee.com/security/runtime/devapp |
Get traffic data for every API proxy for a developer app and time range | get | https://apisecurity.enterprise.apigee.com/security/runtime/devapp/proxy |
Get the timeseries data for a fault code based on a resource grouping | get | https://apisecurity.enterprise.apigee.com/security/runtime/faultcode/resource |
Get the distribution of errors per fault code for an organization and environment | get | https://apisecurity.enterprise.apigee.com/security/runtime/faultcode/summary |
Get the timeseries data for a specific fault code | get | https://apisecurity.enterprise.apigee.com/security/runtime/faultcode/timeseries |
Get traffic information for the various proxies, separated by HTTP versus HTTPS | get | https://apisecurity.enterprise.apigee.com/security/runtime/proxy |
Get information about traffic on various targets | get | https://apisecurity.enterprise.apigee.com/security/runtime/target |
Get the traffic data for an organization and environment | get | https://apisecurity.enterprise.apigee.com/security/runtime/traffic |
Get user activity details for a given user in specified time range | get | https://apisecurity.enterprise.apigee.com/security/users/activity |
Get aggregated user activity information for all users in an organization for specified time range | get | https://apisecurity.enterprise.apigee.com/security/users/summary |
App keys
Company app keys | Developer app keys
Company app keys
Operation | Method | Path |
---|---|---|
Get details for a consumer key for a company app | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or add an API product to an API key for a company app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API key for a company app and remove all API products associated with the app | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve or revoke an API product for an API key for a company app> | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Remove an API product from a company app's consumer key | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a custom consumer key and secret for a company app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Developer app keys
Operation | Method | Path |
---|---|---|
Get details for a consumer key for a developer app | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or add an API product to an API key for a developer app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update the allowed OAuth scopes associated with an app | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an API key for a developer app and remove all API products associated with the app | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve or revoke an API product for an API key for a developer app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Remove an API product from a developer app's consumer key | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a custom consumer key and secret for a developer app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Apps
Apps in an organization | Company apps | Developer apps
Apps in an organization
Operation | Method | Path |
---|---|---|
List apps in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps |
Gets an app in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name}/apps/{app_id} |
Company apps
Operation | Method | Path |
---|---|---|
List company apps in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an app associated with a company | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the profile for a company app | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Set the API key status of a company app to approved or revoked | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an existing company app | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a company app | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Developer apps
Operation | Method | Path |
---|---|---|
List apps created by a developer in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an app associated with a developer | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the profile of a specific developer app | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or generate an API key for a developer app | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an existing developer app | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Deletes a developer app | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get developer app attributes and their values | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update app attributes | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a developer app attribute | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a developer app attribute | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a developer app attribute | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Audits
Operation | Method | Path |
---|---|---|
List audit entries | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for all API products | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for an API product | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for all API proxies | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for an API proxy | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for all developers | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for a developer | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for all developer apps | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for an app | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for all shared flows | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for a shared flow | get | https://api.enterprise.apigee.com/v1/audits/organizations/{org_name} |
List audit entries for a user | get | https://api.enterprise.apigee.com/v1/audits/users/{user_email} |
Cached logs
Operation | Method | Path |
---|---|---|
List the names of the available cached log categories for the specified API | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the most recent log records for the specified API and category | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Caches
Operation | Method | Path |
---|---|---|
List caches | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a cache | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a cache | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a cache | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a cache | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Clear all cache entries | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Clear a cache entry | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Companies
Operation | Method | Path |
---|---|---|
List companies | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a company | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a company | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a company | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a company | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Company developers
Operation | Method | Path |
---|---|---|
List developers in a company | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Add a developer to a company, or update an existing developer in the company | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Remove a developer from a company | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Data masks
Operation | Method | Path |
---|---|---|
List data masks defined for an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a data mask for an API proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the details for a data mask defined for an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a data mask defined for an API Proxy | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List data masks defined for an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a data mask for an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the details for a data mask defined for an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a data mask defined for an organization | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Debug sessions
Operation | Method | Path |
---|---|---|
List debug sessions | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a debug session | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a debug session | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List transaction IDs for a debug session | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get debug session transaction data | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Deployments
Operation | Method | Path |
---|---|---|
Get details for all deployments of the API proxy across all environments | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get deployment details for a specific revision of an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Force the undeployment of an API proxy. | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List all API proxies that are deployed for all environments in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get deployment details for an API proxy in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Gets deployment details for a specific revision of an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Deploy a revision of an API proxy to an environment in an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Undeploys an API proxy revision from an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List all API proxies that are deployed to the specified environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get deployment details for a specific revision of a shared flow | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Deploy a revision of a shared flow to an environment in an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Undeploy a shared flow revision from an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get details for all deployments of the shared flows across all environments | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Developers
Operation | Method | Path |
---|---|---|
List developers in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a profile for a developer in an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the profile for a developer by email address | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Set a developer's status to active or inactive for a specific organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an existing developer profile | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a developer from an organization | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get developer attributes and their values | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update or create developer attributes | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the value of a developer attribute | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update the value of a developer attribute | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a developer attribute | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Environments
Operation | Method | Path |
---|---|---|
List environments in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an environment in an existing organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get environment details | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an existing environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the UUIDs of the Message Processors associated with the environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Associate or disassociate an environment and a Message Processor | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Extensions
Operation | Method | Path |
---|---|---|
Get public extensions packages | get | https://api.enterprise.apigee.com/extensionpackages |
Get the permalink for the specified extension package extensions | get | https://api.enterprise.apigee.com/extensionpackages/{name}/{version} |
Get a collection of extensions | get | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Create a new extension by configuring an instance of an installed extension and adding it to the specified organization | post | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Delete all extensions in an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Get an extension | get | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Update an extension | patch | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Delete an extension | delete | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Get the logs of a deployed extension | get | https://api.enterprise.apigee.com/v1/organizations/{org}/environments |
Key value maps (KVMs)
Operation | Method | Path |
---|---|---|
List KVMs scoped to an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a KVM scoped to an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a KVM scoped to an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a KVM scoped to an organization | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an entry in a KVM scoped to an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the value of a key in a KVM scoped to an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an entry in a KVM scoped to an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an entry in a KVM scoped to an organization | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the keys in a KVM scoped to an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List KVMs scoped to an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a KVM scoped to an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a KVM scoped to an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name |
Delete a KVM scoped to an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an entry in a KVM scoped to an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the value of a key in a KVM scoped to an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an entry in a KVM scoped to an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an entry in a KVM scoped to an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the keys in a KVM scoped to an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List KVMs scoped to an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a KVM scoped to an API proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a KVM scoped to an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name |
Delete a KVM scoped to an API proxy | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an entry in a KVM scoped to an API proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the value of a key in a KVM scoped to an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an entry in a KVM scoped to an API proxy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an entry in a KVM scoped to an API proxy | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the keys in a KVM scoped to an API proxy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a KVM scoped to an API proxy revision | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an entry in a KVM scoped to an API proxy revision | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an entry in a KVM scoped to an API proxy revision | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Lists keys in a KVM scoped to an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Keystores and truststores
Operation | Method | Path |
---|---|---|
Lists keystores and truststores in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a keystore or truststore in an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a keystore or truststore in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a keystore or truststore in an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List aliases in a keystore | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an alias in a keystore | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get details about an alias | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a certificate in an alias | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an alias and the associated cert and key | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Export a certificate or certificate chain for an alias in a keystore | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Generate a Certificate Signing Request (CSR) based on the private key for an alias | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List certificates for a keystore or truststore | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Upload a certificate to a truststore in an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get cert details from a keystore or truststore | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete cert from a keystore or truststore | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Export a certificate | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Upload JAR files that contains a cert and private key to a keystore in an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Test your truststore and keystore in the Edge UI | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
LDAP resources
Operation | Method | Path |
---|---|---|
List all LDAP resources associated with an LDAP policy | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create an LDAP resource | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get an LDAP resource | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update an LDAP resource associated with an LDAP policy | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an LDAP resource associated with an LDAP policy | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Mock target
Operation | Method | Path |
---|---|---|
View a personalized greeting for the specified or guest user | get | https://mocktarget.apigee.net |
Validate access using basic authentication | get | https://mocktarget.apigee.net/auth |
View the request headers and body in JSON format | get | https://mocktarget.apigee.net/echo |
Send a request and view the resulting request headers and body in JSON format | post | https://mocktarget.apigee.net/echo |
View help information about available resources in HTML format | get | https://mocktarget.apigee.net/help |
View API affirmation in HTML format | get | https://mocktarget.apigee.net/iloveapis |
View the IP address of the client in JSON format | get | https://mocktarget.apigee.net/ip |
View a sample response in JSON format | get | https://mocktarget.apigee.net/json |
View status code and message for the specified value | get | https://mocktarget.apigee.net/statuscode/{code} |
View a personalized greeting for the specified or guest user | get | https://mocktarget.apigee.net/user |
View a sample response in XML format | get | https://mocktarget.apigee.net/xml |
Monetization
API packages | API products | Billing adjustments | Credit | Currency | Developer categories | Developer roles | Developers | Organization profile | Rate plans | Refunds | Reports | Scheduled jobs | Synchronization | Terms and conditions | Transactions | Webhooks
Monetization: API packages
Operation | Method | Path |
---|---|---|
List API packages | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create an API package | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Add an API product to an API package | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete an API product from an API package | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get an API package | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete an API package | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List API packages accepted by a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List API packages accepted by a company | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: API products
Operation | Method | Path |
---|---|---|
List API products | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get an API product | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List API products that a developer is eligible to access | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List API products that a company is eligible to access | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Billing adjustments
Operation | Method | Path |
---|---|---|
List billing adjustments | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Make a billing adjustment | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a billing adjustment | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a billing adjustment | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a billing adjustment | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Credit
Operation | Method | Path |
---|---|---|
Issue credit to a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get credit limit for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Set credit limit for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Currency
Operation | Method | Path |
---|---|---|
Add supported currencies | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get supported currencies | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get details for a supported currency | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a supported currency | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a supported currency | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Developer categories
Operation | Method | Path |
---|---|---|
List developer categories | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a developer category | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get details for a developer category | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a developer category | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a developer category | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Developer roles
Operation | Method | Path |
---|---|---|
List developer roles | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a developer role | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Developers
Operation | Method | Path |
---|---|---|
List monetization information for all developers | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List transaction activity for all developers | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get monetization information for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List rate plans accepted by a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get account balance for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get tax rate for a developer (DEPRECATED) | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List suspended developers for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a suspended developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Unsuspend a developer | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Unsuspend all developers for an API product | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Notifications
Operation | Method | Path |
---|---|---|
List notifications that have been sent for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get details for a notification | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Reprocess a notification | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List notification conditions and actions | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a notification condition and action | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a notification condition and action | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a notification condition and action | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a notification condition and action | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List notification email templates | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a notification email template | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a notification email template | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a notification email template | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Organization profile
Operation | Method | Path |
---|---|---|
Get organization profile | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update organization profile | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Prepaid accounts
Operation | Method | Path |
---|---|---|
List prepaid balances and recurring setup for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Reload prepaid account balance for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Set up automatic reload of prepaid account balances for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get prepaid account balance details for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List prepaid balances and recurring setup for a company | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Reload prepaid account balance for a company | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Set up automatic reload of prepaid account balance for a company | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get third-party payment providers for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Configure third-party payment providers for an organization | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update third-party payment providers for an organization | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete third-party payment providers for an organization | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Rate plans
Operation | Method | Path |
---|---|---|
Create a rate plan | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List rate plans for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/rate-plans |
List rate plans for an API package | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a rate plan for an API package | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a rate plan for an API package | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a revision of an existing rate plan | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a rate plan for an API package | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List active rate plans for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List active rate plans for a developer that contain an API product | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Accept a published rate plans for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get an active rate plan for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Refunds
Operation | Method | Path |
---|---|---|
Post a refund to an API package | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Reports
Operation | Method | Path |
---|---|---|
Generate a report of specified type | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Generate a revenue report for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a report definition for an organization | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List report definitions for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List report definitions for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a report definition for an organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a report definition for an organization | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a report definition for an organization | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a report definition for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Scheduled jobs
Operation | Method | Path |
---|---|---|
List currently scheduled monetization jobs | get | https://api.enterprise.apigee.com/v1/triggers |
Get a scheduled monetization job | get | https://api.enterprise.apigee.com/v1/triggers/{trig_id} |
Update a scheduled monetization job | put | https://api.enterprise.apigee.com/v1/triggers/{trig_id} |
Monetization: Synchronization
Operation | Method | Path |
---|---|---|
Synchronize with monetization your organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Synchronize with monetization the API products in your organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Synchronize with monetization the applications in your organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Synchronize with monetization the developers in your organization | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Terms and conditions
Operation | Method | Path |
---|---|---|
List terms and conditions | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Add terms and conditions | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a terms and conditions document | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a terms and conditions document | put | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a terms and conditions document | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Accept the terms and conditions for a developer | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Transactions
Operation | Method | Path |
---|---|---|
List API packages with transactions | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get transaction activity for an organization | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get transaction activity for API products | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get transaction activity for apps | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get transaction status for a developer | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Migrate existing transactions or fees | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Monetization: Webhooks
Operation | Method | Path |
---|---|---|
Get webhooks | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Create a webhook | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a webhook | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Update a webhook | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Delete a webhook | delete | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
List available webhook notification trigger types | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Test the execution of a webhook | post | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
Get a sample request payload for the webhook trigger type | get | https://api.enterprise.apigee.com/v1/mint/organizations/{org_name} |
OAuth 1.0a
Access tokens | Request tokens | Verifier tokens
OAuth 1.0a: Access Tokens
Operation | Method | Path |
---|---|---|
Get the OAuth 1.0a access tokens count for the specified developer app key | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the OAuth 1.0 access tokens count for the specified developer app | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the OAuth 1.0a access token count in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get details for an OAuth 1.0 access token | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or update an OAuth 1.0 access token | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an OAuth 1.0 access token | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
OAuth 1.0a: Request Tokens
Operation | Method | Path |
---|---|---|
List OAuth 1.0a request tokens in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get details for the specified OAuth 1.0a request token | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or update an OAuth 1.0a request token | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an OAuth 1.0a request token | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
OAuth 1.0a: Verifier tokens
Operation | Method | Path |
---|---|---|
List OAuth 1.0a verifier codes and details for each verifier in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1 |
Get details for an OAuth 1.0a verifier code | get | https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1 |
Approve or revoke an OAuth 1.0a verfier code | post | https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1 |
Delete an OAuth 1.0a verfier code | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name}/oauth1 |
OAuth2.0
Access tokens | Authorization codes | Refresh tokens
OAuth 2.0: Access Tokens
Operation | Method | Path |
---|---|---|
Get details for an OAuth 2.0 access token | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Approve, revoke, or update an OAuth 2.0 access token | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an OAuth 2.0 access token | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Revoke OAuth2 access tokens by specifying the end user ID, developer app ID, or both | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get an OAuth2 access token by end user ID, developer app ID, or both | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
OAuth 2.0: Authorization codes
Operation | Method | Path |
---|---|---|
List OAuth 2.0 authorization codes in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get details for the specified OAuth 2.0 authorization code | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a specified OAuth 2.0 authorization code | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
OAuth 2.0: Refresh tokens
Operation | Method | Path |
---|---|---|
Approve or revoke an OAuth 2.0 refresh token | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Organizations
Operation | Method | Path |
---|---|---|
List all organizations | get | https://api.enterprise.apigee.com/v1/organizations |
Create an organization | post | https://api.enterprise.apigee.com/v1/organizations |
Get an organization profile | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update organization properties | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete an organization | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get pods associated with an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name}/pods |
Associate or disassociate an organization and a pod | post | https://api.enterprise.apigee.com/v1/organizations/{org_name}/pod |
Policies
Operation | Method | Path |
---|---|---|
List policies for an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a policy for an API proxy revision | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get policy details for an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a policy for an API proxy revision | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
References
Operation | Method | Path |
---|---|---|
List all references in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a reference | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get reference details | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a reference | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a reference | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Reports
Operation | Method | Path |
---|---|---|
List custom analytics report definitions for an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a custom analytics report definition | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the contents of a custom analytics report definition | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a custom analytics report definition | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a custom analytics report definition | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Resource files
Operation | Method | Path |
---|---|---|
List resource files in an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Import and create a resource file for an API proxy revision | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a resource file in an API proxy revision | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a resource file in an API proxy revision | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a resource file in an API proxy revision | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List resource files in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Import and create a resource file for an environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the contents of a resource file in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update the contents of a resource file in an environment | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete the contents of a resource file in an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List resource files in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Import and create a resource file for an organization | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a resource file in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a resource file in an organization | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a resource file in an organization | delete | https://api.enterprise.apigee.com/v1/organizations>/{org_name} |
Shared flows and flow hooks
Operation | Method | Path |
---|---|---|
Get the shared flow attached to a flow hook | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Attach a shared flow to the specified flow hook | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Detache a shared flow from the specified flow hook | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the shared flows in an organization | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Import a ZIP-formatted shared flow configuration bundle | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a shared flow including a list of existing revisions | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a shared flow | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List all revisions for a shared flow | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Export the shared flow configuration for the specified revision as a zip file | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Stats
Operation | Method | Path |
---|---|---|
Get metrics per time interval for an organization and environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get metrics, group them by dimensions, and filter the results | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Subscribe to (optin=true) or unsubscribe from (optin=false) daily analytics reports | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a list of subscribed and unsubscribed users for the daily analytics report | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
TargetServers
Operation | Method | Path |
---|---|---|
List TargetServers in an environment | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a TargetServer in the specified environment | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get TargetServer details | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Modify an existing TargetServer | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a TargetServer configuration from an environment | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
User roles
Operation | Method | Path |
---|---|---|
List user roles | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create user roles | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get the name of a user role | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a user role | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List permissions for resources associated with a user role | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Add permissions for a resource to a user role | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Verify that a user role's permission exists for a specific resource | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a permission for a resource in a user role | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Add permissions for multiple resources to a user role | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
List the users assigned to a role | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Add a user to a role | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Verify roles to which user is assigned | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Remove a user from a role | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Users
Operation | Method | Path |
---|---|---|
List global users | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a global user | post | https://api.enterprise.apigee.com/v1/users |
Get user details | get | https://api.enterprise.apigee.com/v1/users/{user_email} |
Update a user | put | https://api.enterprise.apigee.com/v1/users/{user_email} |
Delete a user | delete | https://api.enterprise.apigee.com/v1/users/{user_email} |
Unlock a user | post | https://api.enterprise.apigee.com/v1/users/{user_email}/status |
Virtual hosts
Operation | Method | Path |
---|---|---|
List virtual hosts | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Create a virtual host | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Get a virtual host | get | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update a virtual host | put | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Delete a virtual host | delete | https://api.enterprise.apigee.com/v1/organizations/{org_name} |
Update the TLS configuration properties for a virtual host (DEPRECATED) | post | https://api.enterprise.apigee.com/v1/organizations/{org_name} |