You're viewing Apigee Edge documentation.
Go to the
Apigee X documentation. info
The following table lists the permissions that you can assign to a role by using the Edge API. See Add permissions to testing role for an example on how to use the API to set a permission for a role.
| Feature area | Permission URI | Verb | Description |
|---|---|---|---|
Analytics |
|||
| Analytics | /environments/*/analytics/admin | PUT | Enable analytics for an environment (Private Cloud only) |
Analytics data export |
|||
| Data export | /environments/*/analytics/exports | GET, PUT | List/create data export job |
| /environments/*/analytics/exports/* | GET | Get export job status | |
| /analytics/datastores | GET, PUT | List/create analytics data stores | |
| /analytics/datastores/* | GET | Get analytics data store | |
| /analytics/datastoreConsumers | GET, PUT, DELETE | Get/create/delete analytics data store | |
API models (New UI only) |
|||
| API models | /apimodels | GET, PUT | List/create API models |
| /apimodels/* | GET, PUT, DELETE | Get/update/delete API model | |
API Monitoring (New UI only) |
|||
| API Monitoring | /apimonitoring | GET, PUT, DELETE | List/create/delete API Monitoring entities |
API packages (monetization) |
|||
| API Packages (monetization) | /monetization-packages | GET, PUT | List/create API packages |
| /monetization-packages/* | GET, PUT, DELETE | Get/update/delete an API package | |
| /monetization-packages/*/products/* | GET, PUT, DELETE | Get/add/delete an API product in an API package | |
| /developers/*/monetization-packages | GET | List all API packages accepted by a developer | |
API products |
|||
| API products | /apiproducts | GET, PUT | List/create API products |
| /apiproducts/* | GET, PUT, DELETE | Get/update/delete API product | |
| API product attributes | /apiproducts/*/attributes | GET, PUT | List/update all API product attributes |
| /apiproducts/*/attributes/* | GET, PUT, DELETE | Get/update/delete API product attribute | |
API proxies |
|||
| API proxies | /applications | GET, PUT | List/create API proxies |
| /applications/* | GET, PUT, DELETE | Get/update/delete API proxy | |
| API proxy by revision | /applications/*/revisions | GET | List API proxy revisions |
| /applications/*/revisions/* | GET, PUT, DELETE | Get/update/delete API proxy revision | |
| API proxy deployments | /applications/*/deployments | GET | List all API proxy deployments |
| /applications/*/revisions/*/deployments | GET, PUT | List/undeploy API proxy revisions | |
| API proxy deployments at the environment level | /environments/*/deployments | GET | List API proxies deployed in an environment |
| /environments/*/applications/*/deployments | GET | Get deployment details for an API proxy in an environment | |
| API proxy deployments at the environment and revision level | /environments/*/applications/*/revisions/*/deployments | GET, PUT, DELETE | Get deployment details for an API proxy revision in an environment, deploy/undeploy API proxy revision |
| API proxy npm dependencies | /applications/*/revisions/*/npm | GET | Gets npm dependencies for an API Proxy. |
| API proxy policies | /applications/*/revisions/*/policies | GET, PUT | List/create policies in an API proxy |
| /applications/*/revisions/*/policies/* | GET | Get policy at the API proxy scope | |
Apps |
|||
| Apps | /apps | GET | List apps |
| /apps/* | GET | Get app by app ID | |
Asynch query |
|||
| Queries | /environments/*/queries | GET, PUT | List/create asynch query |
| /environments/*/queries/* | GET | Get asynch query status | |
| /environments/*/queries/*/result | GET | Get asynch query results | |
Audits |
|||
| Audits | /audits/organizations/* | GET | List audit entries for all organization |
| /audits/organizations/*/apiproducts | GET | List audit entries for all API products in an organization | |
| /audits/organizations/*/apiproducts/* | GET | List audit entries for API product in an organization | |
| /audits/organizations/*/applications | GET | List audit entries for all applications in an organization | |
| /audits/organizations/*/applications/* | GET | List audit entries for an application in an organization | |
| /audits/organizations/*/developers | GET | List audit entries for all developers in an organization | |
| /audits/organizations/*/developers/* | GET | List audit entries for a developer in an organization | |
| /audits/organizations/*/developers/*/apps | GET | List audit entries for all developer apps in an organization | |
| /audits/organizations/*/developers/*/apps/* | GET | List audit entries for a developer app in an organization | |
| /audits/users/* | GET | List audit entries for all users in an organization | |
Caches |
|||
| Cached logs | /environments/*/applications/*/cachedlogs/categories | GET | Get cached log categories |
| /environments/*/applications/*/cachedlogs/categories/nodejs | GET | Get cached Node.js logs | |
| Caches | /environments/*/caches | GET, PUT | List/create caches |
| /environments/*/caches/* | GET, PUT, DELETE | Get/update/delete cache | |
| /environments/*/caches/*/entries | PUT | Clear all cache entries | |
| /environments/*/caches/*/entries/* | PUT | Clear a cache entries | |
Companies (monetization) |
|||
| Companies (monetization) | /companies | GET, PUT | List/create company |
| /companies/* | GET, PUT, DELETE | Get/update/delete company | |
| Company app families (monetization) | /companies/*/appfamilies | GET, PUT | List/create company app families |
| /companies/*/appfamilies/* | GET, PUT, DELETE | Get/update/delete company app family | |
| /companies/*/appfamilies/*/apps/* | DELETE | Remove company app from family | |
| Company apps (monetization) | /companies/*/apps | GET, PUT | List/create company apps |
| /companies/*/apps/* | GET, PUT, DELETE | Get/update/delete company app | |
| Company app keys (monetization) | /companies/*/apps/*/keys/* | GET | Get company app key by ID |
| Company app developers (monetization) | /companies/*/developers | GET, PUT | List/create company app developers |
| /companies/*/developers/* | GET, PUT, DELETE | Get/update/delete company app developer | |
Credits (monetization) |
|||
| Credits (monetization) | /monetization-packages/*/rate-plans/*/real-currency-credit-transactions | PUT | Issue credit to a developer |
| /transaction-search | PUT | List credits issued | |
Custom reports |
|||
| Custom reports | /reports | GET, PUT | List/create custom analytics reports |
| /reports/* | GET, PUT, DELETE | Get/update/delete custom analytics report | |
| /environments/*/analytics/admin/* | GET | Get metrics and dimensions used to create analytics reports | |
Data masks |
|||
| Data masks at the organization scope | /maskconfigs | GET, PUT | List/create data masks at the organization scope |
| /maskconfigs/* | GET, PUT, DELETE | Get/update/delete data mask at the organization scope | |
| Data masks at the API proxy scope | /apiproxies/*/maskconfigs | GET, PUT | List/create data masks at the API proxy scope |
| /apiproxies/*/maskconfigs/* | GET, PUT, DELETE | Get/update/delete data mask at the API proxy scope | |
| /applications/*/maskconfigs | GET, PUT | List/create data masks at the API proxy scope | |
| /applications/*/maskconfigs/* | GET, PUT, DELETE | Get/update/delete data mask at the API proxy scope | |
Debug |
|||
| Debug | /environments/*/applications/*/revisions/*/debugsessions | GET, PUT | List/create debug sessions |
| /environments/*/applications/*/revisions/*/debugsessions/* | GET, PUT, DELETE | Get/update/delete debug sessions | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data | GET | List debug session transaction IDs | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data/* | GET | Get debug session transaction data by ID | |
Deployments |
|||
| Deployments at the organization level | /deployments | GET | List all APIs deployed to an organization |
Developers |
|||
| Developers | /developers | GET, PUT | List/create app developers |
| /developers/* | GET, PUT, DELETE | Get/update/delete app developer | |
| Developer app attributes | /developers/*/apps/*/attributes | GET, PUT | List/update all developer app attributes |
| /developers/*/apps/*/attributes/* | GET, PUT, DELETE | Get/update/delete developer app attribute | |
| Developer app families | /developers/*/appfamilies | GET, PUT | List/create developer app families |
| /developers/*/appfamilies/* | GET, PUT, DELETE | Get/update/delete developer app family | |
| /developers/*/appfamilies/*/apps/* | DELETE | Remove developer app from family | |
| Developer app keys | /developers/*/apps/*/keys/* | GET, PUT, DELETE | List/update/delete developer app key |
| /developers/*/apps/*/keys/create | PUT | Create a consumer key and secret for an app | |
| /developers/*/apps/*/keys/*/apiproducts/* | PUT, DELETE | Approve/revoke a consumer key for an app | |
| /developers/*/apps/*/keys/*/oauth1accesstokens | GET | Get count of OAuth 1.0 access tokens for a developer's app key. | |
| /developers/*/apps/*/keys/*/oauth2accesstokens | GET | Get count of OAuth 2.0 access tokens for a developer's app key. | |
| /developers/*/apps/*/oauth1accesstokens | GET | Get count of OAuth 1.0 access tokens for a developer's app. | |
| /developers/*/apps/*/oauth2accesstokens | GET | Get count of OAuth 2.0 access tokens for a developer's app. | |
| Developer apps | /developers/*/apps | GET, PUT | List/create developer apps |
| /developers/*/apps/* | GET, PUT, DELETE | Get/update/delete developer app | |
| Developer attributes | /developers/*/attributes | GET, PUT | List/update all developer attributes |
| /developers/*/attributes/* | GET, PUT, DELETE | Get/update/delete developer attribute | |
Keystores |
|||
| Keystores | /environments/*/keystores | GET, PUT | List/create keystores |
| /environments/*/keystores/* | GET, PUT, DELETE | Get/update/delete keystore | |
| /environments/*/keystores/*/aliases | GET, PUT | List/create keystore aliases | |
| /environments/*/keystores/*/aliases/* | GET, PUT, DELETE | Get/update/delete keystore alias | |
| /environments/*/keystores/*/aliases/*/certificate | GET | Export a certificate for an alias | |
| /environments/*/keystores/*/aliases/*/csr | GET | Generate a CSR for an alias | |
| /environments/*/keystores/*/certs | GET, PUT | List/upload keystore cert | |
| /environments/*/keystores/*/certs/* | GET, PUT, DELETE | Get/update/delete keystore cert | |
| /environments/*/keystores/*/certs/*/export | GET | Export a cert from a keystore | |
| /environments/*/keystores/*/keys | PUT | Upload a JAR file to a keystore | |
| /environments/*/testssl | GET, PUT | Test a keystore or truststore | |
Key Value Maps (KVMs) |
|||
| Key Value Maps (KVMs) at the organization scope | /keyvaluemaps | GET, PUT | List/create KVMs at the organization scope |
| /keyvaluemaps/* | GET, PUT, DELETE | Get/update/delete KVM at the organization scope | |
| /keyvaluemaps/*/entries | PUT | Create KVM entries at the organization scope | |
| /keyvaluemaps/*/entries/* | GET, PUT, DELETE | Get/update/delete KVM entry at the organization scope | |
| /keyvaluemaps/*/keys | GET | List keys in a KVM at the organization scope | |
| Key Value Maps (KVMs) at the environment scope | /environments/*/keyvaluemaps | GET, PUT | List/create KVMs at the environment scope |
| /environments/*/keyvaluemaps/* | GET, PUT, DELETE | Get/update/delete KVM at the environment scope | |
| /environments/*/keyvaluemaps/*/entries | PUT | Create KVM entries at the environment scope | |
| /environments/*/keyvaluemaps/*/entries/* | GET, PUT, DELETE | Get/update/delete KVM entry at the environment scope | |
| /environments/*/keyvaluemaps/*/keys | GET | List keys in a KVM at the environment scope | |
| Key Value Maps (KVMs) at the API proxy scope | /applications/*/keyvaluemaps | GET, PUT | List/create KVMs at the API proxy scope |
| /applications/*/keyvaluemaps/* | GET, PUT, DELETE | Get/update/delete KVM at the API proxy scope | |
| /applications/*/keyvaluemaps/*/entries | GET, PUT | List/create KVM entries at the API proxy scope | |
| /applications/*/keyvaluemaps/*/entries/* | GET, PUT, DELETE | Get/update/delete KVM entry at the API proxy scope | |
| /applications/*/keyvaluemaps/*/keys | GET | Get all KVM entrries at the API proxy scope | |
OAuth |
|||
| OAuth 1.0 | /oauth1/accesstokens | GET | Get count of OAuth 1.0 access tokens |
| /oauth1/accesstokens/* | GET, PUT, DELETE | Get/update/delete/approve OAuth 1.0 access token | |
| /oauth1/requesttokens | GET | Get count of OAuth 1.0 request tokens | |
| /oauth1/requesttokens/* | GET, PUT, DELETE | Get/update/delete/approve OAuth 1.0 request token | |
| /oauth1/verifiers | GET | Get count of OAuth 1.0 verifier codes | |
| /oauth1/verifiers/* | GET, DELETE | Get/update/delete/approve OAuth 1.0 verifier code | |
| OAuth 2.0 | /oauth2/accesstokens/* | GET, PUT, DELETE | Get/update/delete/approve OAuth 2.0 access token |
| /oauth2/authorizationcodes | GET | Get count of OAuth 2.0 authorization codes | |
| /oauth2/authorizationcodes/* | GET, DELETE | Get/update/delete/approve OAuth 2.0 authorization codes | |
| /oauth2/refreshtokens/* | PUT | Approve or revoke an OAuth 2.0 refresh token | |
| /oauth2/revoke | PUT | Revoke OAuth 2.0 access token by user or app ID | |
| /oauth2/search | GET | Get OAuth 2.0 access token by User or app ID | |
Organizations |
|||
| Organizations | / | GET, PUT | List/create organization resources |
| /* | GET, PUT, DELETE | Get/update/delete organization resources | |
Rate plans (monetization) |
|||
| Rate Plans (monetization) | /monetization-packages/*/rate-plans | GET, PUT | List/create rate plans |
| /monetization-packages/*/rate-plans/* | GET, PUT, DELETE | Get/update/delete a rate plan | |
| /monetization-packages/*/rate-plans/*/revision | PUT | Create a rate plan revision (or future rate plan) | |
References |
|||
| References | /environments/*/references | GET, PUT | List/create reference at the environment scope |
| /environments/*/references/* | GET, PUT, DELETE | Get/update/delete reference at the environment scope | |
Refunds (monetization) |
|||
| Refunds (monetization) | /monetization-packages/*/refund-transactions | PUT | Issue a refund |
| /transaction-search | PUT | List refunds issued | |
Reports (monetization) |
|||
| Reports (monetization) | /report-definitions | GET, PUT | List/create reports definitions |
| /report-definitions/* | GET, PUT, DELETE | Get/update/delete a report definition | |
| /billing-reports
/revenue-reports /prepaid-balance-reports /variance-reports |
PUT | Generate a report | |
Resource files |
|||
| Resource files at the organization scope | /resourcefiles | GET, PUT | List/upload resource files at the organization scope |
| /resourcefiles/*/* | GET, PUT, DELETE | Get/update/delete resource file at the organization scope | |
| Resource files at the environment scope | /environments/*/resourcefiles | GET, PUT | List/import resource files at the environment scope |
| /environments/*/resourcefiles/*/* | GET, PUT, DELETE | Get/update/delete resource file at the environment scope | |
| Resource files at the API proxy scope | /applications/*/revisions/*/resourcefiles | GET, PUT | List/import resource files at the API proxy scope |
| /applications/*/revisions/*/resourcefiles/*/* | GET, PUT, DELETE | Get/update/delete resource file at the API proxy scope | |
Roles |
|||
| Roles | /userroles | GET, PUT | List/create user roles |
| /userroles/* | GET, PUT, DELETE | Get/update/delete user role | |
| /userroles/*/permissions | GET, PUT | List/add permissions for a role | |
| /userroles/*/permissions/* | GET, PUT, DELETE | Get/update/delete permission for a role | |
| /userroles/*/resourcepermissions | PUT | Add multiple resource permissions for a resource | |
| /userroles/*/users | GET, PUT | List/add users to role | |
| /userroles/*/users/* | GET, DELETE | Verify user in role, remove user from role | |
Shared Flows |
|||
| Shared Flows | /sharedflows | GET, PUT | List/create shared flows. |
| /sharedflows/* | GET, PUT, DELETE | View/delete shared flow. | |
| /sharedflows/*/deployments | GET | View shared flow deployments. | |
| /sharedflows/*/revisions | GET | View shared flow revisions. | |
| /sharedflows/*/revisions/* | GET, PUT, DELETE | View, modify, and delete shared flow revisions. | |
| /sharedflows/*/revisions/*/deployments | GET, DELETE | View/delete deployment of a shared flow revisions. | |
| /environments/*/sharedflows/*/revisions/*/deployments | PUT, DELETE | Deploy and undeploy shared flow revisions. | |
| /environments/*/flowhooks/* | GET, PUT, DELETE | Shared flows on flow hooks: attach, detach, and get. | |
Stats |
|||
| Stats | /stats/ | GET | Get metrics per time interval for an organization and environment. |
| /environments/*/stats/* | GET | Get metrics organized by dimensions | |
| /stats/preferences/reports/dailysummaryreport | GET | Subscribe or unsubscribe from analytics report | |
| /stats/preferences/reports/dailysummaryreport/users | GET | Get list of subscribed and unsubscribed users | |
Target servers |
|||
| Target servers | /environments/*/targetservers | GET, PUT | List/create target servers |
| /environments/*/targetservers/* | GET, PUT, DELETE | Get/update/delete target server | |
Users |
|||
| Users | /users | GET, PUT | List/add users |
| /users/* | GET, PUT, DELETE | Get/update/delete user | |
Transactions (monetization) |
|||
| Transactions (monetization) | /transactions/developers/* | GET | View the status of transactions |
Virtual hosts |
|||
| Virtual hosts | /environments/*/virtualhosts | GET, PUT | List/create virtual hosts (create for Private Cloud and paid Cloud organizations only) |
| /environments/*/virtualhosts/* | GET, PUT, DELETE | Get/update/delete virtual hosts (update/delete for Private Cloud and paid Cloud organizations only) | |
| /environments/*/virtualhosts/*/sslinfo | PUT | Update TLS configuration for a virtual host (Private Cloud and paid Cloud organizations only) | |