Skip to main content
API7.ai Logo

API7 Enterprise Admin APIs

API7 Enterprise Admin APIs are RESTful APIs that allow you to create, configure, and manage all API7 Enterprise resources programmatically. These APIs power the API7 Dashboard and can be used...

Service

Route

Stream Route

Consumer

Gateway Group

Gateway Instance

SSL

Certificate

CACertificate

SNI

  • GET List all SNIs on a gateway group /apisix/admin/snis

    List SNI configurations for the gateway group, including hostname and mTLS related settings. Use filters to locate entries by domain, labels, or mTLS enablement. Required IAM Permission: Action gateway:GetSNI, Resource arn:api7:gateway:gatewaygroup/%s

  • POST Create an SNI /apisix/admin/snis

    Create an SNI entry that maps one or more hostnames to TLS certificates in the gateway group. This allows a single gateway to serve multiple domains over HTTPS. Required IAM Permission: Action gateway:CreateSNI, Resource arn:api7:gateway:gatewaygroup/%s

  • GET Get an SNI on a gateway group /apisix/admin/snis/{sni_id}

    Retrieve the configuration of a specific SNI entry in the gateway group, including bound domains and certificate references. Required IAM Permission: Action gateway:GetSNI, Resource arn:api7:gateway:gatewaygroup/%s

  • PUT Update an SNI on a gateway group /apisix/admin/snis/{sni_id}

    Replace an existing SNI configuration in full, such as domain mappings, certificate bindings, or mTLS options. Updates take effect on TLS handshakes for matching hostnames. Required IAM Permission: Action gateway:UpdateSNI, Resource arn:api7:gateway:gatewaygroup/%s

  • DELETE Delete an SNI on a gateway group /apisix/admin/snis/{sni_id}

    Delete an SNI entry from the gateway group to remove its hostname-to- certificate mapping. Verify that traffic for those domains has a replacement SNI before deletion. Required IAM Permission: Action gateway:DeleteSNI, Resource arn:api7:gateway:gatewaygroup/%s

  • PATCH Patch an SNI on a gateway group /apisix/admin/snis/{sni_id}

    Partially update selected SNI fields using JSON Patch (RFC 6902). This is useful for incremental hostname or certificate adjustments without replacing the entire SNI object. Required IAM Permission: Action gateway:UpdateSNI, Resource arn:api7:gateway:gatewaygroup/%s

Global Rule

Plugin

Plugin Metadata

Custom Plugin

Secret Provider

Proto

Service Registry

User

Role

Permission Policy

Token

Dashboard Login Option

License

Label

Alert

  • GET List all alert policies /api/alert/policies

    List alert policies configured for monitoring conditions such as error rates, latency thresholds, and availability checks. Use query filters to narrow results by severity, status, labels, and search terms. Required IAM Permission: Action gateway:GetAlertPolicy, Resource...

  • POST Create an alert policy /api/alert/policies

    Create a new alert policy that defines trigger conditions, evaluation behavior, and notification routing. After creation, the policy can begin generating alert history entries when conditions are met. Required IAM Permission: Action gateway:CreateAlertPolicy, Resource...

  • GET Get an alert policy /api/alert/policies/{alert_policy_id}

    Retrieve the full configuration of a specific alert policy, including its trigger rules and notification settings. Use this endpoint before updating or troubleshooting policy behavior. Required IAM Permission: Action gateway:GetAlertPolicy, Resource arn:api7:gateway:alert/%s

  • PUT Update an alert policy /api/alert/policies/{alert_policy_id}

    Replace the full configuration of an alert policy with the provided payload. Use this operation when you want to update all policy fields in a single request. Required IAM Permission: Action gateway:UpdateAlertPolicy, Resource arn:api7:gateway:alert/%s

  • DELETE Delete an alert policy /api/alert/policies/{alert_policy_id}

    Delete an existing alert policy so it no longer evaluates conditions or sends notifications. This action affects future alerting only and does not remove historical alert records. Required IAM Permission: Action gateway:DeleteAlertPolicy, Resource arn:api7:gateway:alert/%s

  • PATCH Patch an alert policy /api/alert/policies/{alert_policy_id}

    Partially update an alert policy using JSON Patch (RFC 6902) operations. This is useful for targeted edits without resubmitting the full policy definition. Required IAM Permission: Action gateway:UpdateAlertPolicy, Resource arn:api7:gateway:alert/%s

  • GET List all alert histories /api/alert/policies/histories

    List historical alert events triggered by alert policies, including occurrence time, severity, and related gateway group context. Use time-range and policy filters to investigate incidents and alert trends. Required IAM Permission: Action gateway:GetAlertPolicy, Resource...

Contact Point

Audit Logs

  • GET List all audit logs /api/audit_logs

    Retrieve immutable audit log records for administrative and configuration actions, including who performed each action and when. Use filters such as event type, operator, resource, gateway group, and time range to narrow the result set. Required IAM Permission: Action...

  • GET List all event types of audit logs /api/audit_logs/event_types

    List supported audit event types that can be used for filtering and analysis when querying audit logs. No IAM permission required.

  • GET Export all audit logs /api/audit_logs/export

    Export audit logs that match the specified filters into a downloadable file format for compliance, archival, or external analysis. Apply event, operator, resource, and time-range filters before export to control data scope. Required IAM Permission: Action iam:ExportAudits...

Audit Config

Monitoring

Debugger

Schema

Variables

System Settings

Developer Portal Settings

System Infos

Email

Common

Provider Portal - DCR Provider

Provider Portal - API Product

Provider Portal - Portal Instance

Provider Portal - Portal Token

Developer

Approval

  • GET List approvals /api/approvals

    List pending and processed approval workflow items for developer portal operations, such as API product subscriptions and developer registrations. Use filters to review approvals by status, event type, operator, applicant, and resource. Required IAM Permission: For event type...

  • POST Accept an approval request /api/approvals/{approval_id}/accept

    Approve a specific workflow request and apply the corresponding portal-side change, such as granting an API product subscription or accepting a developer sign-up. This operation advances the approval lifecycle to an accepted state. Required IAM Permission: For event type api...

  • POST Reject an approval request /api/approvals/{approval_id}/reject

    Reject a specific workflow approval request so the requested action is not applied. Use this endpoint to explicitly deny subscription or registration requests that do not meet review criteria. Required IAM Permission: For event type api product subscription: Action...

AI Gateway Group

AI Gateway Instance

Configuration

  • POST Validate batch configuration /apisix/admin/configs/validate

    Validate a batch of APISIX declarative configurations including routes, services, consumers, upstreams, etc. Performs resource-level JSON Schema validation, plugin check schema advanced validation, and duplicate ID detection. Returns all validation errors at once.

File

Model Catalog

  • GET List model catalog entries /api/model_catalogs

    IAM Action: ai gateway:ListModelCatalogs, Resource: arn:api7:ai gateway:modelcatalog/ Returns globally synchronized model catalog entries that can be used to populate AI model selections. Set compact=true to receive the reduced dropdown-oriented item shape.

  • POST Trigger a manual model catalog sync /api/model_catalogs/sync

    IAM Action: ai gateway:SyncModelCatalog, Resource: arn:api7:ai gateway:modelcatalog/ Triggers an immediate synchronization against the configured upstream model catalog endpoint. Remote fetch failures are returned as HTTP 200 with success=false; HTTP 409 is reserved for...

  • GET List model catalog sync logs /api/model_sync_logs

    IAM Action: ai gateway:ListModelSyncLogs, Resource: arn:api7:ai gateway:modelcatalog/ Returns synchronization history entries, including execution status and structured diff information.

AI Model

AI API Key

AI Provider

AI Gateway Log