Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
En la siguiente tabla, se enumeran los permisos que puedes asignar a un rol con la API de Edge. Consulta Cómo agregar permisos al rol de prueba para ver un ejemplo de cómo usar la API para establecer un permiso para un rol.
| Área de características | URI de permiso | Verbo | Descripción |
|---|---|---|---|
Analytics |
|||
| Analytics | /environments/*/analytics/admin | PUT | Habilita las estadísticas para un entorno (solo para la nube privada) |
Exportación de datos de Analytics |
|||
| Exportación de datos | /environments/*/analytics/exports | GET y PUT | Cómo enumerar o crear un trabajo de exportación de datos |
| /environments/*/analytics/exports/* | GET | Cómo obtener el estado del trabajo de exportación | |
| /analytics/datastores | GET y PUT | Cómo enumerar o crear almacenes de datos de estadísticas | |
| /analytics/datastores/* | GET | Cómo obtener el almacén de datos de estadísticas | |
| /analytics/datastoreConsumers | GET, PUT y DELETE | Cómo obtener, crear o borrar un almacén de datos de estadísticas | |
Modelos de API (solo IU nueva) |
|||
| Modelos de API | /apimodels | GET y PUT | Enumera o crea modelos de API |
| /apimodels/* | GET, PUT y DELETE | Obtén, actualiza o borra el modelo de API | |
Supervisión de API (solo IU nueva) |
|||
| Supervisión de API | /apimonitoring | GET, PUT y DELETE | Cómo enumerar, crear o borrar entidades de supervisión de API |
Paquetes de API (monetización) |
|||
| Paquetes de API (monetización) | /monetization-packages | GET y PUT | Cómo enumerar o crear paquetes de API |
| /monetization-packages/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un paquete de API | |
| /monetization-packages/*/products/* | GET, PUT y DELETE | Obtén, agrega o borra un producto de API en un paquete de API | |
| /developers/*/monetization-packages | GET | Enumera todos los paquetes de API que aceptó un desarrollador | |
Productos de API |
|||
| Productos de API | /apiproducts | GET y PUT | Cómo enumerar o crear productos de API |
| /apiproducts/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un producto de API | |
| Atributos de producto de API | /apiproducts/*/attributes | GET y PUT | Cómo enumerar o actualizar todos los atributos de productos de API |
| /apiproducts/*/attributes/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un atributo de producto de API | |
Proxies de API |
|||
| Proxies de API | /applications | GET y PUT | Cómo enumerar o crear proxies de API |
| /applications/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un proxy de API | |
| Proxy de API por revisión | /applications/*/revisions | GET | Cómo enumerar las revisiones del proxy de API |
| /applications/*/revisions/* | GET, PUT y DELETE | Obtén, actualiza o borra la revisión del proxy de API | |
| Implementaciones de proxy de API | /applications/*/deployments | GET | Enumera todas las implementaciones de proxy de API |
| /applications/*/revisions/*/deployments | GET y PUT | Cómo enumerar o anular la implementación de revisiones del proxy de API | |
| Implementaciones de proxy de API a nivel del entorno | /environments/*/deployments | GET | Enumerar los proxies de API implementados en un entorno |
| /environments/*/applications/*/deployments | GET | Obtén detalles sobre la implementación de un proxy de API en un entorno | |
| Implementaciones de proxy de API a nivel del entorno y de la revisión | /environments/*/applications/*/revisions/*/deployments | GET, PUT y DELETE | Obtén detalles sobre la implementación de una revisión del proxy de API en un entorno, implementa o desimplementa la revisión del proxy de API |
| Dependencias de npm del proxy de API | /applications/*/revisions/*/npm | GET | Obtiene dependencias de npm para un proxy de API. |
| Políticas de proxy de API | /applications/*/revisions/*/policies | GET y PUT | Cómo enumerar o crear políticas en un proxy de API |
| /applications/*/revisions/*/policies/* | GET | Cómo obtener la política en el alcance del proxy de API | |
Apps |
|||
| Aplicaciones | /apps | GET | Mostrar apps |
| /apps/* | GET | Cómo obtener la app por ID | |
Consulta asíncrona |
|||
| Consultas | /environments/*/queries | GET y PUT | Cómo enumerar o crear una consulta asíncrona |
| /environments/*/queries/* | GET | Obtén el estado de la consulta asíncrona | |
| /environments/*/queries/*/result | GET | Cómo obtener resultados de consultas asíncronas | |
Auditorías |
|||
| Auditorías | /audits/organizations/* | GET | Enumera las entradas de auditoría de toda la organización |
| /audits/organizations/*/apiproducts | GET | Enumera las entradas de auditoría de todos los productos de API de una organización | |
| /audits/organizations/*/apiproducts/* | GET | Enumera las entradas de auditoría del producto de API en una organización | |
| /audits/organizations/*/applications | GET | Enumera las entradas de auditoría de todas las aplicaciones de una organización | |
| /audits/organizations/*/applications/* | GET | Enumera las entradas de auditoría de una aplicación en una organización | |
| /audits/organizations/*/developers | GET | Enumera las entradas de auditoría de todos los desarrolladores de una organización | |
| /audits/organizations/*/developers/* | GET | Cómo enumerar las entradas de auditoría de un desarrollador en una organización | |
| /audits/organizations/*/developers/*/apps | GET | Enumera las entradas de auditoría de todas las apps de desarrollador de una organización | |
| /audits/organizations/*/developers/*/apps/* | GET | Cómo enumerar las entradas de auditoría de una app de desarrollador en una organización | |
| /audits/users/* | GET | Enumera las entradas de auditoría de todos los usuarios de una organización | |
Caché |
|||
| Registros almacenados en caché | /environments/*/applications/*/cachedlogs/categories | GET | Obtén categorías de registro almacenadas en caché |
| /environments/*/applications/*/cachedlogs/categories/nodejs | GET | Cómo obtener registros de Node.js almacenados en caché | |
| Caché | /environments/*/caches | GET y PUT | Cómo enumerar o crear cachés |
| /environments/*/caches/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar la caché | |
| /environments/*/caches/*/entries | PUT | Borra todas las entradas de caché | |
| /environments/*/caches/*/entries/* | PUT | Borra una entrada de caché | |
Empresas (monetización) |
|||
| Empresas (monetización) | /companies | GET y PUT | Cómo enumerar o crear una empresa |
| /companies/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar una empresa | |
| Familias de aplicaciones empresariales (monetización) | /companies/*/appfamilies | GET y PUT | Cómo enumerar o crear familias de apps empresariales |
| /companies/*/appfamilies/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar la familia de apps de la empresa | |
| /companies/*/appfamilies/*/apps/* | BORRAR | Cómo quitar la app de la empresa de la familia | |
| Aplicaciones de empresas (monetización) | /companies/*/apps | GET y PUT | Cómo enumerar o crear apps de empresas |
| /companies/*/apps/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar una app empresarial | |
| Claves de la aplicación empresarial (monetización) | /companies/*/apps/*/keys/* | GET | Cómo obtener la clave de la app de la empresa por ID |
| Desarrolladores de apps de la empresa (monetización) | /companies/*/developers | GET y PUT | Cómo enumerar o crear desarrolladores de apps de la empresa |
| /companies/*/developers/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el desarrollador de la app de la empresa | |
Créditos (monetización) |
|||
| Créditos (monetización) | /monetization-packages/*/rate-plans/*/real-currency-credit-transactions | PUT | Emite crédito a un desarrollador |
| /transaction-search | PUT | Lista de créditos emitidos | |
Informes personalizados |
|||
| Informes personalizados | /reports | GET y PUT | Cómo enumerar o crear informes de estadísticas personalizados |
| /reports/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un informe de estadísticas personalizado | |
| /environments/*/analytics/admin/* | GET | Obtén las métricas y dimensiones que se usan para crear informes de estadísticas | |
Máscaras de datos |
|||
| Máscaras de datos a nivel de la organización | /maskconfigs | GET y PUT | Cómo enumerar o crear máscaras de datos a nivel de la organización |
| /maskconfigs/* | GET, PUT y DELETE | Obtén, actualiza o borra la máscara de datos a nivel de la organización | |
| Máscaras de datos en el alcance del proxy de API | /apiproxies/*/maskconfigs | GET y PUT | Cómo enumerar o crear máscaras de datos en el alcance del proxy de API |
| /apiproxies/*/maskconfigs/* | GET, PUT y DELETE | Obtén, actualiza o borra la máscara de datos en el permiso del proxy de API | |
| /applications/*/maskconfigs | GET y PUT | Cómo enumerar o crear máscaras de datos en el alcance del proxy de API | |
| /applications/*/maskconfigs/* | GET, PUT y DELETE | Obtén, actualiza o borra la máscara de datos en el permiso del proxy de API | |
Depuración |
|||
| Depurar | /environments/*/applications/*/revisions/*/debugsessions | GET y PUT | Enumera o crea sesiones de depuración |
| /environments/*/applications/*/revisions/*/debugsessions/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar sesiones de depuración | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data | GET | Enumera los IDs de transacción de la sesión de depuración | |
| /environments/*/applications/*/revisions/*/debugsessions/*/data/* | GET | Obtén datos de transacciones de la sesión de depuración por ID | |
Deployments |
|||
| Implementaciones a nivel de la organización | /deployments | GET | Enumera todas las APIs implementadas en una organización |
Desarrolladores |
|||
| Desarrolladores | /developers | GET y PUT | Cómo enumerar o crear desarrolladores de apps |
| /developers/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el desarrollador de una app | |
| Atributos de la app para desarrolladores | /developers/*/apps/*/attributes | GET y PUT | Cómo enumerar o actualizar todos los atributos de apps de desarrollador |
| /developers/*/apps/*/attributes/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un atributo de app de desarrollador | |
| Familias de apps de desarrollador | /developers/*/appfamilies | GET y PUT | Cómo enumerar o crear familias de apps de desarrollador |
| /developers/*/appfamilies/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar una familia de apps de desarrollador | |
| /developers/*/appfamilies/*/apps/* | BORRAR | Cómo quitar la app del desarrollador de la familia | |
| Claves de apps para desarrolladores | /developers/*/apps/*/keys/* | GET, PUT y DELETE | Cómo enumerar, actualizar o borrar la clave de app de desarrollador |
| /developers/*/apps/*/keys/create | PUT | Crea una clave y un secreto de consumidor para una app | |
| /developers/*/apps/*/keys/*/apiproducts/* | PUT y DELETE | Aprueba o revoca una clave de consumidor para una app | |
| /developers/*/apps/*/keys/*/oauth1accesstokens | GET | Obtén el recuento de tokens de acceso de OAuth 1.0 para la clave de app de un desarrollador. | |
| /developers/*/apps/*/keys/*/oauth2accesstokens | GET | Obtén el recuento de tokens de acceso de OAuth 2.0 para la clave de app de un desarrollador. | |
| /developers/*/apps/*/oauth1accesstokens | GET | Obtén el recuento de tokens de acceso de OAuth 1.0 para la app de un desarrollador. | |
| /developers/*/apps/*/oauth2accesstokens | GET | Obtén el recuento de tokens de acceso de OAuth 2.0 para la app de un desarrollador. | |
| Apps de desarrolladores | /developers/*/apps | GET y PUT | Cómo enumerar o crear apps de desarrollador |
| /developers/*/apps/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar una app de desarrollador | |
| Atributos de desarrollador | /developers/*/attributes | GET y PUT | Cómo enumerar o actualizar todos los atributos de desarrollador |
| /developers/*/attributes/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un atributo de desarrollador | |
Almacén de claves |
|||
| Almacén de claves | /environments/*/keystores | GET y PUT | Cómo enumerar o crear almacenes de claves |
| /environments/*/keystores/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el almacén de claves | |
| /environments/*/keystores/*/aliases | GET y PUT | Cómo enumerar o crear alias de almacenes de claves | |
| /environments/*/keystores/*/aliases/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el alias del almacén de claves | |
| /environments/*/keystores/*/aliases/*/certificate | GET | Cómo exportar un certificado de un alias | |
| /environments/*/keystores/*/aliases/*/csr | GET | Genera un CSR para un alias | |
| /environments/*/keystores/*/certs | GET y PUT | Cómo enumerar o subir certificados de almacén de claves | |
| /environments/*/keystores/*/certs/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el certificado del almacén de claves | |
| /environments/*/keystores/*/certs/*/export | GET | Cómo exportar un certificado de un almacén de claves | |
| /environments/*/keystores/*/keys | PUT | Sube un archivo JAR a un almacén de claves | |
| /environments/*/testssl | GET y PUT | Prueba un almacén de claves o almacén truststore | |
Mapas de clave-valor (KVM) |
|||
| Mapas de par clave-valor (KVM) dentro del alcance de la organización | /keyvaluemaps | GET y PUT | Enumera o crea KVMs a nivel del alcance de la organización |
| /keyvaluemaps/* | GET, PUT y DELETE | Obtén, actualiza o borra KVM a nivel del alcance de la organización | |
| /keyvaluemaps/*/entries | PUT | Crea entradas de KVM a nivel de la organización | |
| /keyvaluemaps/*/entries/* | GET, PUT y DELETE | Obtén, actualiza o borra la entrada de KVM a nivel del alcance de la organización | |
| /keyvaluemaps/*/keys | GET | Cómo enumerar las claves de un KVM a nivel de la organización | |
| Mapas de par clave-valor (KVM) dentro del alcance del entorno | /environments/*/keyvaluemaps | GET y PUT | Enumera o crea KVMs en el alcance del entorno |
| /environments/*/keyvaluemaps/* | GET, PUT y DELETE | Obtén, actualiza o borra KVM a nivel del alcance del entorno | |
| /environments/*/keyvaluemaps/*/entries | PUT | Crea entradas de KVM en el alcance del entorno | |
| /environments/*/keyvaluemaps/*/entries/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar la entrada de KVM en el alcance del entorno | |
| /environments/*/keyvaluemaps/*/keys | GET | Enumera las claves de un KVM a nivel del alcance del entorno | |
| Mapas de par clave-valor (KVM) en el alcance del proxy de API | /applications/*/keyvaluemaps | GET y PUT | Cómo enumerar o crear KVM en el permiso del proxy de API |
| /applications/*/keyvaluemaps/* | GET, PUT y DELETE | Obtén, actualiza o borra KVM en el permiso del proxy de API | |
| /applications/*/keyvaluemaps/*/entries | GET y PUT | Cómo enumerar o crear entradas de KVM en el permiso del proxy de API | |
| /applications/*/keyvaluemaps/*/entries/* | GET, PUT y DELETE | Obtén, actualiza o borra la entrada de KVM en el permiso del proxy de API | |
| /applications/*/keyvaluemaps/*/keys | GET | Obtén todas las entradas de KVM en el permiso del proxy de API | |
OAuth |
|||
| OAuth 1.0 | /oauth1/accesstokens | GET | Obtén el recuento de tokens de acceso de OAuth 1.0 |
| /oauth1/accesstokens/* | GET, PUT y DELETE | Obtén, actualiza, borra o aprueba el token de acceso de OAuth 1.0 | |
| /oauth1/requesttokens | GET | Obtén el recuento de tokens de solicitud de OAuth 1.0 | |
| /oauth1/requesttokens/* | GET, PUT y DELETE | Obtén, actualiza, borra o aprueba el token de solicitud de OAuth 1.0 | |
| /oauth1/verifiers | GET | Obtén el recuento de códigos de verificador de OAuth 1.0 | |
| /oauth1/verifiers/* | GET y DELETE | Obtén, actualiza, borra o aprueba el código del verificador de OAuth 1.0 | |
| OAuth 2.0 | /oauth2/accesstokens/* | GET, PUT y DELETE | Obtén, actualiza, borra o aprueba tokens de acceso de OAuth 2.0 |
| /oauth2/authorizationcodes | GET | Obtén el recuento de códigos de autorización de OAuth 2.0 | |
| /oauth2/authorizationcodes/* | GET y DELETE | Cómo obtener, actualizar, borrar o aprobar códigos de autorización de OAuth 2.0 | |
| /oauth2/refreshtokens/* | PUT | Aprueba o revoca un token de actualización de OAuth 2.0 | |
| /oauth2/revoke | PUT | Revoca el token de acceso de OAuth 2.0 por ID de usuario o de app | |
| /oauth2/search | GET | Obtén un token de acceso de OAuth 2.0 por ID de usuario o de app | |
Organizaciones |
|||
| Organizaciones | / | GET y PUT | Cómo enumerar o crear recursos de organización |
| /* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar recursos de la organización | |
Planes de tarifas (monetización) |
|||
| Planes de tarifas (monetización) | /monetization-packages/*/rate-plans | GET y PUT | Enumera o crea planes de tarifas |
| /monetization-packages/*/rate-plans/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un plan de tarifas | |
| /monetization-packages/*/rate-plans/*/revision | PUT | Crea una revisión del plan de tarifas (o un plan de tarifas futuro) | |
References |
|||
| Referencias | /environments/*/references | GET y PUT | Cómo enumerar o crear referencias en el alcance del entorno |
| /environments/*/references/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar referencias en el alcance del entorno | |
Reembolsos (monetización) |
|||
| Reembolsos (monetización) | /monetization-packages/*/refund-transactions | PUT | Emisión de un reembolso |
| /transaction-search | PUT | Lista de reembolsos emitidos | |
Informes (monetización) |
|||
| Informes (monetización) | /report-definitions | GET y PUT | Cómo enumerar o crear definiciones de informes |
| /report-definitions/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar la definición de un informe | |
| /billing-reports
/revenue-reports /prepaid-balance-reports /variance-reports |
PUT | Genera un informe | |
Archivos de recursos |
|||
| Archivos de recursos a nivel de la organización | /resourcefiles | GET y PUT | Enumera o sube archivos de recursos en el alcance de la organización |
| /resourcefiles/*/* | GET, PUT y DELETE | Obtén, actualiza o borra un archivo de recursos a nivel de la organización | |
| Archivos de recursos en el alcance del entorno | /environments/*/resourcefiles | GET y PUT | Enumera o importa archivos de recursos en el alcance del entorno |
| /environments/*/resourcefiles/*/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un archivo de recursos en el alcance del entorno | |
| Archivos de recursos en el alcance del proxy de API | /applications/*/revisions/*/resourcefiles | GET y PUT | Cómo enumerar o importar archivos de recursos en el alcance del proxy de API |
| /applications/*/revisions/*/resourcefiles/*/* | GET, PUT y DELETE | Obtén, actualiza o borra el archivo de recursos en el alcance del proxy de API | |
Funciones |
|||
| Funciones | /userroles | GET y PUT | Cómo enumerar o crear roles de usuario |
| /userroles/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el rol de un usuario | |
| /userroles/*/permissions | GET y PUT | Cómo enumerar o agregar permisos para un rol | |
| /userroles/*/permissions/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el permiso de un rol | |
| /userroles/*/resourcepermissions | PUT | Cómo agregar varios permisos de recursos para un recurso | |
| /userroles/*/users | GET y PUT | Cómo mostrar una lista de usuarios o agregarlos a un rol | |
| /userroles/*/users/* | GET y DELETE | Verifica si el usuario tiene un rol y, luego, quítalo | |
Flujos compartidos |
|||
| Flujos compartidos | /sharedflows | GET y PUT | Enumera o crea flujos compartidos. |
| /sharedflows/* | GET, PUT y DELETE | Ver o borrar un flujo compartido | |
| /sharedflows/*/deployments | GET | Consulta las implementaciones de flujos compartidos. | |
| /sharedflows/*/revisions | GET | Consulta las revisiones de flujo compartido. | |
| /sharedflows/*/revisions/* | GET, PUT y DELETE | Ver, modificar y borrar revisiones de flujos compartidos | |
| /sharedflows/*/revisions/*/deployments | GET y DELETE | Ver o borrar la implementación de revisiones de un flujo compartido | |
| /environments/*/sharedflows/*/revisions/*/deployments | PUT y DELETE | Implementa y anula la implementación de revisiones de flujo compartido. | |
| /environments/*/flowhooks/* | GET, PUT y DELETE | Flujos compartidos en hooks de flujo: adjunta, desconecta y obtén. | |
Stats |
|||
| Estadísticas | /stats/ | GET | Obtén métricas por intervalo de una organización y un entorno. |
| /environments/*/stats/* | GET | Obtén métricas organizadas por dimensiones | |
| /stats/preferences/reports/dailysummaryreport | GET | Cómo suscribirse o anular la suscripción a un informe de estadísticas | |
| /stats/preferences/reports/dailysummaryreport/users | GET | Obtén una lista de los usuarios suscritos y no suscritos | |
Servidores de destino |
|||
| Servidores de destino | /environments/*/targetservers | GET y PUT | Cómo enumerar o crear servidores de destino |
| /environments/*/targetservers/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar el servidor de destino | |
Usuarios |
|||
| Usuarios | /users | GET y PUT | Cómo mostrar una lista de usuarios o agregarlos |
| /users/* | GET, PUT y DELETE | Cómo obtener, actualizar o borrar un usuario | |
Transacciones (monetización) |
|||
| Transacciones (monetización) | /transactions/developers/* | GET | Consulta el estado de las transacciones |
Hosts virtuales |
|||
| Hosts virtuales | /environments/*/virtualhosts | GET y PUT | Muestra una lista de hosts virtuales o crea uno (solo para organizaciones de nube privada y nube pagada) |
| /environments/*/virtualhosts/* | GET, PUT y DELETE | Obtener, actualizar o borrar hosts virtuales (solo actualización o eliminación para organizaciones de nube privada y nube pagada) | |
| /environments/*/virtualhosts/*/sslinfo | PUT | Actualiza la configuración de TLS para un host virtual (solo para organizaciones de nube privada y nube pagada) | |