Skip to main content
AI Data Engine

AIDE REST API resources

Contributors dmp-netapp
PDFs

The ONTAP REST API includes new endpoints to support the AI Data Engine (AIDE) features and capabilities.

New resource categories in the ONTAP REST API for AFX

There are two new resource categories added to the ONTAP REST API to support AIDE functionality and features.

DCN

DCN resources primarily support data compute node infrastructure and lifecycle management. These endpoints are used to manage and observe the DCN cluster itself, including node and cluster management, telemetry and health, and similar platform tasks. ONTAP acts as a DCN client, constructing REST requests to services running on the DCNs, rather than functioning as a raw pass-through proxy. The typical capabilities include:

  • DCN cluster as well as node inventory and status.

  • DCN cluster lifecycle operations, including the ability to create, expand, replace, and remove nodes.

  • Telemetry and operational checks needed by ONTAP to coordinate with the DCN cluster.

All these capabilities are generally surfaced under the ONTAP REST API subtree /api/dcn and are available when ONTAP is running in an environment with attached and active DCNs.

ONTAP also exposes two HTTP path prefixes that are proxied directly to the DCNs:

  • Console or UI proxy with no ONTAP authentication: /console/…​

  • DCN proxy that requires ONTAP authentication and is used for monitoring: /dcn/…​

Data Engine

The Data Engine resources support the AIDE data plane and governance/metadata management. The endpoints focus on managing the objects AIDE operates on. The capabilities can be broadly organized in subcategories.

Core object model and CRUD

There are several endpoints that provide access to core AIDE objects, including:

  • Workspaces and workspace versions

  • Entities

  • Access control lists (ACLs)

  • Queries

  • Data sources

  • Data collections

Governance, audit, and supporting services

There are several endpoints that provide access to governance and miscellaneous supporting services, including:

  • Policies and policy management

  • Events and audit logs related to AIDE operations

  • Autosupport configuration

  • Application and feature toggles for AIDE capabilities

  • Governance areas typically used by roles

Also note the following:

  • Many of the long-running operations (create, modify, delete) run asynchronously and return a job reference that clients can poll for status.

  • In many cases ONTAP does not proxy requests, but rather reconstructs them for the Data Engine endpoints and translates the responses as part of its DCN client behavior.

Updates to existing ONTAP REST API resources

In addition to the new resource categories, there are updates to existing ONTAP REST API resources.

Security

There are several new endpoints and capabilities added to the security section of the ONTAP REST API to support AIDE, including:

  • Certificates and certificate management

  • OIDC authentication configuration

  • User identity including role and permissions