GET List all published services on a gateway group /apisix/admin/servicesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a published service on a gateway group /apisix/admin/servicesIAM Action: gateway:CreatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/
GET Get a published service on a gateway group /apisix/admin/services/{service_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a published service without publishing /apisix/admin/services/{service_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a published service on a gateway group /apisix/admin/services/{service_id}IAM Action: gateway:DeletePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Patch a published service on a gateway group /apisix/admin/services/{service_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all upstreams in a published service on a gateway group /apisix/admin/services/{service_id}/upstreamsIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a upstream in a published service on a gateway group /apisix/admin/services/{service_id}/upstreamsIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a upstream in a published service on a gateway group /apisix/admin/services/{service_id}/upstreams/{upstream_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a upstream in a published service on a gateway group /apisix/admin/services/{service_id}/upstreams/{upstream_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a upstream in a published service on a gateway group /apisix/admin/services/{service_id}/upstreams/{upstream_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Patch a upstream in a published service on a gateway group /apisix/admin/services/{service_id}/upstreams/{upstream_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Import services based on OpenAPI Specification /api/import/servicesIAM Action: gateway:CreatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/
PUT Convert OpenAPI Specification to service and route resources /api/openapi/convertConvert a given OpenAPI Specification to service and route resources without creating these resources.
GET List all routes in a published service /apisix/admin/routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a route in a published service on a gateway group /apisix/admin/routesIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a route in a published servcie on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Patch a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all stream routes in a published service on a gateway group /apisix/admin/stream_routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a stream route in a published service on a gateway group /apisix/admin/stream_routesIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all published services in a gateway group /api/gateway_groups/{gateway_group_id}/servicesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s Deprecated, you can use GET /apisix/admin/services for instead.
GET Get a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}IAM Action: gateway:DeletePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the OpenAPI Specification of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/oasIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update the OpenAPI Specification of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/oasIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all routes of published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the runtime configuration of a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update the runtime configuration of a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all stream routes of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the runtime configuration of a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update the runtime configuration of a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all history versions of a published services on a gateway group by service ID /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/versionsIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get service runtime configurations of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update service runtime configurations of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get healthcheck status for the upstream of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/healthcheckIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all published services connected to a service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/connected_servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
POST Check service conflict /api/services/conflict_checkGET Get all service templates /api/services/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Create a service template /api/services/templateIAM Action: gateway:CreateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/
GET Get a service template by ID /api/services/template/{service_template_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PUT Update a service template by ID /api/services/template/{service_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
DELETE Delete a service template /api/services/template/{service_template_id}IAM Action: gateway:DeleteServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PATCH Patch a service template by ID /api/services/template/{service_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get the OpenAPI Specification of a service template /api/services/template/{service_template_id}/oasIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PUT Update the OpenAPI Specification of a service template /api/services/template/{service_template_id}/oasIAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Generate an OpenAPI specification from service templates /api/export/services/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Import service template based on OpenAPI Specification /api/import/services/templateIAM Action: gateway:CreateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/
PUT Convert OpenAPI Specification to service and route resources /api/openapi/convertConvert a given OpenAPI Specification to service and route resources without creating these resources.
GET Get all routes in a service template /api/routes/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Create a route in a service template /api/routes/templateIAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a route in all service templates /api/routes/template/{route_template_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PUT Update a route in service template /api/routes/template/{route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
DELETE Delete a route in service template /api/routes/template/{route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PATCH Patch a route in service template /api/routes/template/{route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET List all stream routes in a service template /api/stream_routes/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Create a stream route in a service template /api/stream_routes/templateIAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PUT Update a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
DELETE Delete a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get the OpenAPI Specification of a service version /api/service_versions/{service_version_id}/oasIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a service version /api/service_versions/{service_version_id}The service version can be found by listing all service versions. IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get all routes in a service version /api/service_versions/{service_version_id}/routesIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a route in a service version /api/service_versions/{service_version_id}/routes/{route_version_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get all stream routes in a service versions /api/service_versions/{service_version_id}/stream_routesIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a stream route in a service version /api/service_versions/{service_version_id}/stream_routes/{stream_route_version_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Publish a service template to a gateway group /api/services/publishIAM Action: gateway:PublishServices, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all published version of a service template on multiple gateway groups /api/services/{service_template_id}/published_servicesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the service version name /api/services/{service_template_id}/versions/{version}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET List all secret providers on a gateway group /apisix/admin/secret_providersIAM Action: gateway:GetSecretProvider, Resource: arn:api7:gateway:gatewaygroup/%s/secret provider/%s
GET Get a secret provider on a gateway group /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}IAM Action: gateway:GetSecretProvider, Resource: arn:api7:gateway:gatewaygroup/%s/secret provider/%s
PUT Update a secret provider on a gateway group /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}IAM Action: gateway:PutSecretProvider, Resource: arn:api7:gateway:gatewaygroup/%s/secret provider/%s
DELETE Delete a secret provider on a gateway group /apisix/admin/secret_providers/{secret_provider}/{secret_provider_id}IAM Action: gateway:DeleteSecretProvider, Resource: arn:api7:gateway:gatewaygroup/%s/secret provider/%s
GET List all protos on a gateway group /apisix/admin/protosIAM Action: gateway:GetProto, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a proto on a gateway group /apisix/admin/protosIAM Action: gateway:CreateProto, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a proto on a gateway group /apisix/admin/protos/{proto_id}IAM Action: gateway:GetProto, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a proto on a gateway group /apisix/admin/protos/{proto_id}IAM Action: gateway:UpdateProto, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a proto on a gateway group /apisix/admin/protos/{proto_id}IAM Action: gateway:DeleteProto, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get API7 Enterprise license details /api/licensePUT Import or update the API7 Enterprise license /api/licenseIAM Action: iam:UpdateLicense, Resource: arn:api7:iam:organization/
GET List all routes in a published service /apisix/admin/routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a route in a published service on a gateway group /apisix/admin/routesIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a route in a published servcie on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Patch a route in a published service on a gateway group /apisix/admin/routes/{route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get all routes in a service template /api/routes/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Create a route in a service template /api/routes/templateIAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a route in all service templates /api/routes/template/{route_template_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
DELETE Delete a route in service template /api/routes/template/{route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PATCH Patch a route in service template /api/routes/template/{route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all stream routes in a published service on a gateway group /apisix/admin/stream_routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
POST Create a stream route in a published service on a gateway group /apisix/admin/stream_routesIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a stream route in a published service on a gateway group /apisix/admin/stream_routes/{stream_route_id}IAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all stream routes in a service template /api/stream_routes/templateIAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
POST Create a stream route in a service template /api/stream_routes/templateIAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET Get a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:GetServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
PUT Update a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
DELETE Delete a stream route in a service template /api/stream_routes/template/{stream_route_template_id}IAM Action: gateway:UpdateServiceTemplate, Resource: arn:api7:gateway:servicetemplate/%s
GET List all stream routes of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all SSL certificates on a gateway group /apisix/admin/sslsIAM Action: gateway:GetSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create an SSL certificate /apisix/admin/sslsIAM Action: gateway:CreateSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get an SSL certificate on a gateway group /apisix/admin/ssls/{ssl_id}IAM Action: gateway:GetSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update an SSL certificate on a gateway group /apisix/admin/ssls/{ssl_id}IAM Action: gateway:UpdateSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete an SSL certificate on a gateway group /apisix/admin/ssls/{ssl_id}IAM Action: gateway:DeleteSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Parse an SSL certificate /api/parse_certificatePUT Validate an SSL certificate and key /api/validate_cert_keyGET List all certificates on a gateway group /apisix/admin/certificatesIAM Action: gateway:GetCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a certificate /apisix/admin/certificatesIAM Action: gateway:CreateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a certificate on a gateway group /apisix/admin/certificates/{certificate_id}IAM Action: gateway:GetCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a certificate on a gateway group /apisix/admin/certificates/{certificate_id}IAM Action: gateway:UpdateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a certificate on a gateway group /apisix/admin/certificates/{certificate_id}IAM Action: gateway:DeleteCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PATCH Patch a certificate on a gateway group /apisix/admin/certificates/{certificate_id}IAM Action: gateway:UpdateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all CA certificates on a gateway group /apisix/admin/ca_certificatesIAM Action: gateway:GetCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a CA certificate /apisix/admin/ca_certificatesIAM Action: gateway:CreateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a CA certificate on a gateway group /apisix/admin/ca_certificates/{ca_certificate_id}IAM Action: gateway:GetCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a CA certificate on a gateway group /apisix/admin/ca_certificates/{ca_certificate_id}IAM Action: gateway:UpdateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a CA certificate on a gateway group /apisix/admin/ca_certificates/{ca_certificate_id}IAM Action: gateway:DeleteCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
PATCH Patch a CA certificate on a gateway group /apisix/admin/ca_certificates/{ca_certificate_id}IAM Action: gateway:UpdateCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all SNIs on a gateway group /apisix/admin/snisIAM Action: gateway:GetSNI, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create an SNI /apisix/admin/snisIAM Action: gateway:CreateSNI, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get an SNI on a gateway group /apisix/admin/snis/{sni_id}IAM Action: gateway:GetSNI, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update an SNI on a gateway group /apisix/admin/snis/{sni_id}IAM Action: gateway:UpdateSNI, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete an SNI on a gateway group /apisix/admin/snis/{sni_id}IAM Action: gateway:DeleteSNI, Resource: arn:api7:gateway:gatewaygroup/%s
PATCH Patch an SNI on a gateway group /apisix/admin/snis/{sni_id}IAM Action: gateway:UpdateSNI, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all consumers on a gateway group /apisix/admin/consumersIAM Action: gateway:GetConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
POST Create a consumer on a gateway group /apisix/admin/consumersIAM Action: gateway:CreateConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/
GET Get a consumer on a gateway group /apisix/admin/consumers/{username}IAM Action: gateway:GetConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
PUT Update a consumer on a gateway group /apisix/admin/consumers/{username}IAM Action: gateway:UpdateConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
DELETE Delete a consumer /apisix/admin/consumers/{username}IAM Action: gateway:DeleteConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
PATCH Update a consumer on a gateway group /apisix/admin/consumers/{username}IAM Action: gateway:UpdateConsumer, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
GET List all consumer credentials on a gateway group /apisix/admin/consumers/{username}/credentialsIAM Action: gateway:GetConsumerCredential, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
POST Create a consumer credential on a gateway group /apisix/admin/consumers/{username}/credentialsIAM Action: gateway:CreateConsumerCredential, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
GET Get a consumer credential on a gateway group /apisix/admin/consumers/{username}/credentials/{credential_id}IAM Action: gateway:GetConsumerCredential, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
PUT Update a consumer credential on a gateway group /apisix/admin/consumers/{username}/credentials/{credential_id}IAM Action: gateway:UpdateConsumerCredential, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
DELETE Delete a consumer credential /apisix/admin/consumers/{username}/credentials/{credential_id}IAM Action: gateway:DeleteConsumerCredential, Resource: arn:api7:gateway:gatewaygroup/%s/consumer/%s
GET List all DCR providers /api/dcr_providersIAM Action: portal:GetDCRProvider, Resource: arn:api7:portal:dcrprovider/%s
POST Create an DCR provider /api/dcr_providersIAM Action: portal:CreateDCRProvider, Resource: arn:api7:portal:dcrprovider/
GET Get an DCR provider /api/dcr_providers/{dcr_provider_id}IAM Action: portal:GetDCRProvider, Resource: arn:api7:portal:dcrprovider/%s
PUT Update an DCR Provider /api/dcr_providers/{dcr_provider_id}IAM Action: portal:UpdateDCRProvider, Resource: arn:api7:portal:dcrprovider/%s
DELETE Delete an DCR Provider /api/dcr_providers/{dcr_provider_id}IAM Action: portal:DeleteDCRProvider, Resource: arn:api7:portal:dcrprovider/%s
GET List all API products in Provider Portal /api/api_productsIAM Action: portal:GetAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
POST Create an API product in Provider Portal /api/api_productsIAM Action: portal:CreateAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/
GET Get an API product in Provider Portal /api/api_products/{api_product_id}IAM Action: portal:GetAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
PUT Update an API product in Provider Portal /api/api_products/{api_product_id}IAM Action: portal:UpdateAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
DELETE Delete an API product in Provider Portal /api/api_products/{api_product_id}IAM Action: portal:DeleteAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
PATCH Patch an API product in Provider Portal /api/api_products/{api_product_id}IAM Action: portal:UpdateAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
GET List all subscriptions in Provider Portal for an API product /api/api_products/{api_product_id}/subscriptionsIAM Action: portal:GetAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
DELETE Cancel a subscription in Provider Portal for an API product /api/api_products/{api_product_id}/subscriptions/{subscription_id}IAM Action: portal:UpdateAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
GET List all notification histories for an API product /api/api_products/{api_product_id}/notification_historiesIAM Action: portal:GetAPIProduct, Resource: arn:api7:portal:portal/%s/apiproduct/%s
GET List Developers /api/developersIAM Action: portal:GetDeveloper, Resource: arn:api7:portal:portal/%s/developer/%s
DELETE Delete a developer /api/developers/{developer_id}IAM Action: portal:DeleteDeveloper, Resource: arn:api7:portal:portal/%s/developer/%s
POST Invite a developer to the portal /api/developers/invitesIAM Action: portal:InviteDeveloper, Resource: arn:api7:portal:portal/%s/developer/
GET Get provider portal monitoring data at a single point in time /api/portal/monitor/querySee Prometheus instant queries for more information.
GET Get provider portal monitoring data over a range of time /api/portal/monitor/query_rangeSee Prometheus range queries for more information.
GET Get data from Prometheus /api/control_plane/prometheus/{prometheus_path}POST Get data from Prometheus /api/control_plane/prometheus/{prometheus_path}GET List all portal instances /api/portalsIAM Action: portal:ListPortals, Resource: arn:api7:portal:portal/
POST Create a portal instance /api/portalsIAM Action: portal:CreatePortal, Resource: arn:api7:portal:portal/
GET Get a portal instance /api/portals/{portal_id}IAM Action: portal:GetPortal, Resource: arn:api7:portal:portal/%s
PUT Update a portal instance /api/portals/{portal_id}IAM Action: portal:UpdatePortal, Resource: arn:api7:portal:portal/%s
DELETE Delete a portal instance /api/portals/{portal_id}IAM Action: portal:DeletePortal, Resource: arn:api7:portal:portal/%s
GET List all global rules on a gateway group /apisix/admin/global_rulesIAM Action: gateway:GetGlobalPluginRule, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a global rule on a gateway group /apisix/admin/global_rulesIAM Action: gateway:CreateGlobalPluginRule, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a global rule on a gateway group /apisix/admin/global_rules/{global_rule_id}IAM Action: gateway:GetGlobalPluginRule, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a global rule on a gateway group /apisix/admin/global_rules/{global_rule_id}IAM Action: gateway:UpdateGlobalPluginRule, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a global rule on a gateway group /apisix/admin/global_rules/{global_rule_id}IAM Action: gateway:DeleteGlobalPluginRule, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all plugin metadata on a gateway group /apisix/admin/plugin_metadataIAM Action: gateway:GetPluginMetadata, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a plugin metadata on a gateway group /apisix/admin/plugin_metadata/{plugin_name}IAM Action: gateway:GetPluginMetadata, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a plugin metadata on a gateway group /apisix/admin/plugin_metadata/{plugin_name}IAM Action: gateway:UpdatePluginMetadata, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a plugin metadata on a gateway group /apisix/admin/plugin_metadata/{plugin_name}IAM Action: gateway:DeletePluginMetadata, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get the default value of a plugin metadata /apisix/admin/plugin_metadata/{plugin_name}/defaultGET Get all plugin schemas and priorities /apisix/admin/pluginsGET List all plugin names /apisix/admin/plugins/listGET Get schema definition of a plugin /apisix/admin/plugins/{plugin_name}Get schema definition of a plugin, including plugin meta properties and plugin properties. The endpoint returns the same response as the /apisix/admin/schema/plugins/{plugin name} endpoint when scope is not set.
GET Get schema definition of a plugin /apisix/admin/schema/plugins/{plugin_name}Get schema definition of a plugin, including plugin meta properties and plugin properties.
GET Get all plugin details /api/pluginsGET List all plugin catalogs /api/plugins/catalogsGET Get the usage of a plugin in all gateway groups /api/plugins/{plugin_name}/usageGET Get schema by resource name /apisix/admin/schema/{resource_name}GET Get schema definition of a plugin /apisix/admin/schema/plugins/{plugin_name}Get schema definition of a plugin, including plugin meta properties and plugin properties.
GET Get OpenAPI schema /api/openapi/request_body_schemaThe endpoint returns the request body schema of PUT/POST requests for users to understand how to structure a request.
GET Get core resources schema /api/schema/coreGET List all gateway instances of all gateway groups /api/instancesIAM Action: gateway:GetGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all gateway instances on a gateway group /api/gateway_groups/{gateway_group_id}/instancesIAM Action: gateway:GetGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Count the number of gateway instances by status in a gateway group /api/instances/count/{field}IAM Action: gateway:GetGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET List gateway instances cores of all gateway groups /api/instances/coresIAM Action: gateway:GetGatewayInstanceCore, Resource: arn:api7:gateway:gatewaygroup/
GET Export the gateway instance core usage /api/instances/cores_usages/exportThe gateway instance’s core usage is exported hourly within the specified time interval. IAM Action: gateway:GetGatewayInstanceCore, Resource: arn:api7:gateway:gatewaygroup/
GET Generate a script to install the gateway instance by Docker /api/gateway_groups/{gateway_group_id}/deployment/dockerIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install the gateway instance by Docker Compose /api/gateway_groups/{gateway_group_id}/deployment/docker-composeIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install the gateway instance by Helm in Kubernetes /api/gateway_groups/{gateway_group_id}/deployment/helm/scriptIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a values file for the gateway's Kubernetes Helm chart /api/gateway_groups/{gateway_group_id}/deployment/helm/yamlIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete gateway instance /api/gateway_groups/{gateway_group_id}/instances/{gateway_instance_id}IAM Action: gateway:DeleteGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
POST Issue a data plane certificate on a gateway group /api/gateway_groups/{gateway_group_id}/dp_client_certificatesIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a token for all gateway instances in a gateway group /api/gateway_groups/{gateway_group_id}/instance_tokenIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all gateway instances on a gateway group /api/gateway_groups/{gateway_group_id}/instancesIAM Action: gateway:GetGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Count the number of gateway instances by status in a gateway group /api/instances/count/{field}IAM Action: gateway:GetGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Export the gateway instance core usage /api/instances/cores_usages/exportThe gateway instance’s core usage is exported hourly within the specified time interval. IAM Action: gateway:GetGatewayInstanceCore, Resource: arn:api7:gateway:gatewaygroup/
GET List all gateway groups /api/gateway_groupsIAM Action: gateway:GetGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a gateway group /api/gateway_groupsIAM Action: gateway:CreateGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
GET Count resources by type in each gateway group /api/gateway_groups/count/{resource_type}GET List SSL Usage in a gateway group /api/gateway_groups/{gateway_group_id}/ssls/{ssl_id}/usageIAM Action: gateway:GetSSLCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET List SNI Usage in a gateway group /api/gateway_groups/{gateway_group_id}/snis/{sni_id}/usageIAM Action: gateway:GetSNI, Resource: arn:api7:gateway:gatewaygroup/%s
GET List Certificate Usage in a gateway group /api/gateway_groups/{gateway_group_id}/certificates/{certificate_id}/usageIAM Action: gateway:GetCertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET List CA Certificate Usage in a gateway group /api/gateway_groups/{gateway_group_id}/ca_certificates/{ca_certificate_id}/usageIAM Action: gateway:GetCACertificate, Resource: arn:api7:gateway:gatewaygroup/%s
POST Check if a certificate exists in a gateway group /api/gateway_groups/{gateway_group_id}/certificates/existsIAM Action: gateway:GetCACertificate, Resource: arn:api7:gateway:gatewaygroup/%s
POST Check if a CA certificate exists in a gateway group /api/gateway_groups/{gateway_group_id}/ca_certificates/existsIAM Action: gateway:GetCACertificate, Resource: arn:api7:gateway:gatewaygroup/%s
GET List Secret Provider Usage in a gateway group /api/gateway_groups/{gateway_group_id}/secret_providers/{secret_provider}/{secret_provider_id}/usageIAM Action: gateway:GetSecretProvider, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a gateway group /api/gateway_groups/{gateway_group_id}IAM Action: gateway:GetGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a gateway group /api/gateway_groups/{gateway_group_id}IAM Action: gateway:UpdateGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a gateway group /api/gateway_groups/{gateway_group_id}IAM Action: gateway:DeleteGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get the admin key for a gateway group. /api/gateway_groups/{gateway_group_id}/admin_keyIAM Action: gateway:GetAdminKey, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Generate an admin key for a gateway group /api/gateway_groups/{gateway_group_id}/admin_keyIAM Action: gateway:UpdateGatewayGroup, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install the gateway instance by Docker /api/gateway_groups/{gateway_group_id}/deployment/dockerIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install the gateway instance by Docker Compose /api/gateway_groups/{gateway_group_id}/deployment/docker-composeIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install the gateway instance by Helm in Kubernetes /api/gateway_groups/{gateway_group_id}/deployment/helm/scriptIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a values file for the gateway's Kubernetes Helm chart /api/gateway_groups/{gateway_group_id}/deployment/helm/yamlIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate a script to install gateway API resources for ingress gateway group /api/gateway_groups/{gateway_group_id}/ingress/scriptIAM Action: gateway:GetAdminKey, Resource: arn:api7:gateway:gatewaygroup/%s
GET Generate script to install the gateway api resources for ingress gateway group. /api/gateway_groups/{gateway_group_id}/ingress/step1POST Issue a data plane certificate on a gateway group /api/gateway_groups/{gateway_group_id}/dp_client_certificatesIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all published services in a gateway group /api/gateway_groups/{gateway_group_id}/servicesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s Deprecated, you can use GET /apisix/admin/services for instead.
GET Get a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
DELETE Delete a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}IAM Action: gateway:DeletePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the OpenAPI Specification of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/oasIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PUT Update the OpenAPI Specification of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/oasIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all routes of published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the runtime configuration of a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update the runtime configuration of a route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/routes/{route_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all stream routes of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routesIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}IAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get the runtime configuration of a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update the runtime configuration of a stream route in a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/stream_routes/{stream_route_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all history versions of a published services on a gateway group by service ID /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/versionsIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get service runtime configurations of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/runtime_configurationIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
PATCH Update service runtime configurations of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/runtime_configurationIAM Action: gateway:UpdatePublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET Get healthcheck status for the upstream of a published service on a gateway group /api/gateway_groups/{gateway_group_id}/services/{service_template_id}/healthcheckIAM Action: gateway:GetPublishedService, Resource: arn:api7:gateway:gatewaygroup/%s/publishedservice/%s
GET List all service registry connections on a gateway group /api/gateway_groups/{gateway_group_id}/service_registriesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registriesIAM Action: gateway:ConnectServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a token for all gateway instances in a gateway group /api/gateway_groups/{gateway_group_id}/instance_tokenIAM Action: gateway:CreateGatewayInstance, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:UpdateServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:DisconnectServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all published services connected to a service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/connected_servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all internal services in a Kubernetes service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/kubernetes/internal_servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all namespaces in a Nacos service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespacesGET List all groups in a Nacos namespace /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groupsIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all internal services in a Nacos group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groups/{nacos_group}/servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get all instance metadata of a Nacos services registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groups/{nacos_group}/services/{nacos_service}/instances_metadataIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get health check history of a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/health_check_historyIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all users /api/usersIAM Action: iam:GetUser, Resource: arn:api7:iam:user/%s
GET Get a user /api/users/{user_id}IAM Action: iam:GetUser, Resource: arn:api7:iam:user/%s
PUT Update basic attributes of a user /api/users/{user_id}IAM Action: iam:UpdateUser, Resource: arn:api7:iam:user/%s
DELETE Delete a user /api/users/{user_id}IAM Action: iam:DeleteUser, Resource: arn:api7:iam:user/%s
PUT Update the user's permission boundaries /api/users/{user_id}/boundariesUpdate a user’s boundaries using a list of permission policy IDs. IAM Action: iam:UpdateUserBoundary, Resource: arn:api7:iam:user/%s
PUT Reset the password to specific value /api/users/{user_id}/password_resetIAM Action: iam:ResetPassword, Resource: arn:api7:iam:user/%s
GET Get my user detail /api/mePUT Update my user profile /api/mePUT Update the user email /api/me/emailDELETE Delete the user email /api/me/emailPOST Invite a user /api/invitesIAM Action: iam:InviteUser, Resource: arn:api7:iam:user/
PUT Update my user password /api/passwordPOST Log in to API7 Enterprise using the built-in username and password /api/loginPOST Log out from API7 Enterprise using the built-in username and password /api/logoutPUT Update assigned roles for a user /api/users/{user_id}/assigned_rolesIAM Action: iam:UpdateUserRole, Resource: arn:api7:iam:user/%s
POST Check if a user has permissions on specific resources /api/allow_accessPOST Log in to API7 Enterprise using the LDAP username and password /api/ldap/{login_option_id}/loginPOST Log out from API7 Enterprise using the LDAP username and password /api/ldap/{login_option_id}/logoutGET Log in using the CAS provider /api/cas/{login_option_id}/loginGET Log out using the CAS provider /api/cas/{login_option_id}/logoutGET Log in using the OIDC provider /api/oidc/{login_option_id}/loginGET Log in using the OIDC provider /api/oidc/{login_option_id}/callbackGET Log out using the OIDC provider /api/oidc/{login_option_id}/logoutGET SAML login (redirect to IdP and call back to Dashboard) /api/saml/{login_option_id}/loginGET SAML Logout (redirect to IdP and call back to Dashboard) /api/saml/{login_option_id}/logoutPOST SAML ACS/SLO callback (from IdP to Dashboard) /api/saml/{login_option_id}/acsGET SAML ACS/SLO callback (from IdP to Dashboard) /api/saml/{login_option_id}/sloPOST SAML ACS/SLO callback (from IdP to Dashboard) /api/saml/{login_option_id}/sloGET SAML SP metadata /api/saml/{login_option_id}/metadataPUT Update assigned roles for a user /api/users/{user_id}/assigned_rolesIAM Action: iam:UpdateUserRole, Resource: arn:api7:iam:user/%s
GET List all roles /api/rolesIAM Action: iam:GetRole, Resource: arn:api7:iam:role/%s
POST Create a role /api/rolesIAM Action: iam:CreateRole, Resource: arn:api7:iam:role/
GET Get a role /api/roles/{role_id}IAM Action: iam:GetRole, Resource: arn:api7:iam:role/%s
PUT Update a role /api/roles/{role_id}IAM Action: iam:UpdateRole, Resource: arn:api7:iam:role/%s
DELETE Delete a role /api/roles/{role_id}IAM Action: iam:DeleteRole, Resource: arn:api7:iam:role/%s
GET List all permission policies attached to a role /api/roles/{role_id}/permission_policiesIAM Action: iam:GetPermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
POST Attach permission policies to a role /api/roles/{role_id}/attach_permission_policiesIAM Action: iam:UpdateRole, Resource: arn:api7:iam:role/%s
POST Detach permission policies of a role /api/roles/{role_id}/detach_permission_policiesIAM Action: iam:UpdateRole, Resource: arn:api7:iam:role/%s
POST Check if a user has permissions on specific resources /api/allow_accessGET List all permission policies attached to a role /api/roles/{role_id}/permission_policiesIAM Action: iam:GetPermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
POST Attach permission policies to a role /api/roles/{role_id}/attach_permission_policiesIAM Action: iam:UpdateRole, Resource: arn:api7:iam:role/%s
POST Detach permission policies of a role /api/roles/{role_id}/detach_permission_policiesIAM Action: iam:UpdateRole, Resource: arn:api7:iam:role/%s
GET List all permission policies /api/permission_policiesIAM Action: iam:GetPermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
POST Create a permission policy /api/permission_policiesIAM Action: iam:CreatePermissionPolicy, Resource: arn:api7:iam:permissionpolicy/
GET Get a permission policy /api/permission_policies/{permission_policy_id}IAM Action: iam:GetPermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
PUT Update a permission policy /api/permission_policies/{permission_policy_id}IAM Action: iam:UpdatePermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
DELETE Delete a permission policy /api/permission_policies/{permission_policy_id}IAM Action: iam:DeletePermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
GET List the Roles or Users that directly reference the Permission Policy /api/permission_policies/{permission_policy_id}/referencesIAM Action: iam:GetPermissionPolicy, Resource: arn:api7:iam:permissionpolicy/%s
GET List all alert policies /api/alert/policiesIAM Action: gateway:GetAlertPolicy, Resource: arn:api7:gateway:alert/%s
POST Create an alert policy /api/alert/policiesIAM Action: gateway:CreateAlertPolicy, Resource: arn:api7:gateway:alert/
GET Get an alert policy /api/alert/policies/{alert_policy_id}IAM Action: gateway:GetAlertPolicy, Resource: arn:api7:gateway:alert/%s
PUT Update an alert policy /api/alert/policies/{alert_policy_id}IAM Action: gateway:UpdateAlertPolicy, Resource: arn:api7:gateway:alert/%s
DELETE Delete an alert policy /api/alert/policies/{alert_policy_id}IAM Action: gateway:DeleteAlertPolicy, Resource: arn:api7:gateway:alert/%s
PATCH Patch an alert policy /api/alert/policies/{alert_policy_id}IAM Action: gateway:UpdateAlertPolicy, Resource: arn:api7:gateway:alert/%s
GET List all alert histories /api/alert/policies/historiesIAM Action: gateway:GetAlertPolicy, Resource: arn:api7:gateway:alert/
GET List all audit logs /api/audit_logsIAM Action: iam:GetAudit, Resource: arn:api7:iam:organization/
GET List all event types of audit logs /api/audit_logs/event_typesGET Export all audit logs /api/audit_logs/exportIAM Action: iam:ExportAudits, Resource: arn:api7:iam:organization/
GET List all service registry connections on a gateway group /api/gateway_groups/{gateway_group_id}/service_registriesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
POST Create a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registriesIAM Action: gateway:ConnectServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
PUT Update a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:UpdateServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
DELETE Delete a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}IAM Action: gateway:DisconnectServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all published services connected to a service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/connected_servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all internal services in a Kubernetes service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/kubernetes/internal_servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all namespaces in a Nacos service registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespacesGET List all groups in a Nacos namespace /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groupsIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET List all internal services in a Nacos group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groups/{nacos_group}/servicesIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get all instance metadata of a Nacos services registry /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/nacos/namespaces/{nacos_namespace}/groups/{nacos_group}/services/{nacos_service}/instances_metadataIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get health check history of a service registry connection on a gateway group /api/gateway_groups/{gateway_group_id}/service_registries/{service_registry_id}/health_check_historyIAM Action: gateway:GetServiceRegistry, Resource: arn:api7:gateway:gatewaygroup/%s
GET Get deployment settings /api/system_settingsPUT Update deployment settings /api/system_settingsIAM Action: gateway:UpdateDeploymentSetting, Resource: arn:api7:gateway:gatewaysetting/
GET Get SCIM settings /api/system_settings/scimIAM Action: iam:GetSCIMProvisioning, Resource: arn:api7:iam:organization/
PUT Update SCIM settings /api/system_settings/scimIAM Action: iam:UpdateSCIMProvisioning, Resource: arn:api7:iam:organization/
PUT Generate SCIM Token /api/system_settings/scim/tokenIAM Action: iam:UpdateSCIMProvisioning, Resource: arn:api7:iam:organization/
GET Get SMTP server settings /api/system_settings/smtp_serverIAM Action: iam:GetSMTPServer, Resource: arn:api7:iam:organization/
PUT Update SMTP server settings /api/system_settings/smtp_serverIAM Action: iam:UpdateSMTPServer, Resource: arn:api7:iam:organization/
GET Get SMTP server settings status /api/system_settings/smtp_server_statusGet SMTP server settings status.
GET Get developer portal public access /api/portal/system_settings/public_accessIAM Action: portal:GetDeveloperPortalPublicAccess, Resource: arn:api7:portal:portal/%s/loginsetting/
PUT Update developer portal public access /api/portal/system_settings/public_accessIAM Action: portal:UpdateDeveloperPortalPublicAccess, Resource: arn:api7:portal:portal/%s/loginsetting/
GET List all developer login options /api/portal/login_optionsIAM Action: portal:GetDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
POST Create a developer login option /api/portal/login_optionsIAM Action: portal:CreateDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
GET Get a developer login option /api/portal/login_options/{login_option_id}IAM Action: portal:GetDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
PUT Update a developer login option /api/portal/login_options/{login_option_id}IAM Action: portal:UpdateDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
DELETE Delete a developer login option /api/portal/login_options/{login_option_id}IAM Action: portal:DeleteDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
PATCH Patch a developer login option /api/portal/login_options/{login_option_id}IAM Action: portal:UpdateDeveloperLoginOption, Resource: arn:api7:portal:portal/%s/loginsetting/
GET Get Developer SCIM settings /api/portal/system_settings/scimIAM Action: portal:GetDeveloperSCIMProvisioning, Resource: arn:api7:portal:portal/%s/loginsetting/
PUT Update Developer SCIM settings /api/portal/system_settings/scimIAM Action: portal:UpdateDeveloperSCIMProvisioning, Resource: arn:api7:portal:portal/%s/loginsetting/
PUT Generate Developer SCIM Token /api/portal/system_settings/scim/tokenIAM Action: portal:UpdateDeveloperSCIMProvisioning, Resource: arn:api7:portal:portal/%s/loginsetting/
GET Get a login option /api/login_options/{login_option_id}IAM Action: iam:GetLoginOption, Resource: arn:api7:iam:organization/
PUT Update a login option /api/login_options/{login_option_id}IAM Action: iam:UpdateLoginOption, Resource: arn:api7:iam:organization/
DELETE Delete a login option /api/login_options/{login_option_id}IAM Action: iam:DeleteLoginOption, Resource: arn:api7:iam:organization/
PATCH Patch a login option /api/login_options/{login_option_id}IAM Action: iam:UpdateLoginOption, Resource: arn:api7:iam:organization/
GET List all login options /api/login_optionsIAM Action: iam:GetLoginOption, Resource: arn:api7:iam:organization/
POST Create a login option /api/login_optionsIAM Action: iam:CreateLoginOption, Resource: arn:api7:iam:organization/
GET List all login options (public) /api/login_options_for_loginList login options. No authentication is required, and provider or policy/role details are not included in the response.
GET List all custom plugins /api/custom_pluginsIAM Action: gateway:GetCustomPlugin, Resource: arn:api7:gateway:gatewaysetting/
POST Create a custom plugin /api/custom_pluginsIAM Action: gateway:CreateCustomPlugin, Resource: arn:api7:gateway:gatewaysetting/
GET Get a custom plugin /api/custom_plugins/{custom_plugin_id}IAM Action: gateway:GetCustomPlugin, Resource: arn:api7:gateway:gatewaysetting/
PUT Update a custom plugin /api/custom_plugins/{custom_plugin_id}IAM Action: gateway:UpdateCustomPlugin, Resource: arn:api7:gateway:gatewaysetting/
DELETE Delete a custom plugin /api/custom_plugins/{custom_plugin_id}IAM Action: gateway:DeleteCustomPlugin, Resource: arn:api7:gateway:gatewaysetting/
PUT Parse custom plugin code /api/custom_plugins/code/parseGET List Contact Points /api/contact_pointsIAM Action: iam:GetContactPoint, Resource: arn:api7:iam:contactpoint/%s
POST Create a contact point /api/contact_pointsIAM Action: iam:CreateContactPoint, Resource: arn:api7:iam:contactpoint/
GET Get a contact point /api/contact_points/{contact_point_id}IAM Action: iam:GetContactPoint, Resource: arn:api7:iam:contactpoint/%s
PUT Update a contact point /api/contact_points/{contact_point_id}IAM Action: iam:UpdateContactPoint, Resource: arn:api7:iam:contactpoint/%s
DELETE Delete a contact point /api/contact_points/{contact_point_id}IAM Action: iam:DeleteContactPoint, Resource: arn:api7:iam:contactpoint/%s
GET List notification logs of a contact point /api/contact_points/{contact_point_id}/notification_logsIAM Action: iam:GetContactPoint, Resource: arn:api7:iam:contactpoint/%s
GET List a contact point usages /api/contact_points/{contact_point_id}/usagesIAM Action: iam:GetContactPoint, Resource: arn:api7:iam:contactpoint/%s
GET List approvals /api/approvalsFor event type api product subscription: IAM Action: portal:ApproveAPIProductSubscription, Resource: arn:api7:portal:portal/%s/apiproduct/%s For event type developer registration: IAM Action: portal:ApproveDeveloperSignUp, Resource: arn:api7:portal:portal/%s/developer/
POST Accept an approval request /api/approvals/{approval_id}/acceptFor event type api product subscription: IAM Action: portal:ApproveAPIProductSubscription, Resource: arn:api7:portal:portal/%s/apiproduct/%s For event type developer registration: IAM Action: portal:ApproveDeveloperSignUp, Resource: arn:api7:portal:portal/%s/developer/
POST Reject an approval request /api/approvals/{approval_id}/rejectFor event type api product subscription: IAM Action: portal:ApproveAPIProductSubscription, Resource: arn:api7:portal:portal/%s/apiproduct/%s For event type developer registration: IAM Action: portal:ApproveDeveloperSignUp, Resource: arn:api7:portal:portal/%s/developer/