For AI agents: the complete documentation index is available at https://docs.dataplatform.ovh.net/llms.txt, the full documentation bundle is available at https://docs.dataplatform.ovh.net/llms-full.txt, and this page is available as Markdown at https://docs.dataplatform.ovh.net/landing-page-app-services-apis.md.
  • 🇬🇧 English

    • Application APIs

    One authenticated path out of the platform.

    What is a Data Platform API?

    An API in a Data Platform project is a deployed service that exposes project data over HTTP, with authentication handled by the project's Identity Access Manager. Applications call the API rather than reaching a database, so credentials and query logic stay inside the platform.

    APIs are built in two ways: from the point-and-click templates shipped with the platform, or from code written against the Front API SDK in NodeJS. Either way the result is versioned, built and deployed through the Application Services lifecycle, and served by nodes that can be scaled out.

    Info

    Any query saved in the Analytics Manager can be exposed as an endpoint, so an analyst's saved query becomes an application's data source with no code in between. Because the query syntax abstracts the underlying store, analytics are served without exposing any database directly.

    Every app in the project is linked to a deployed API: the app knows which API to call to run its queries.

    Extensions are modules attached to an API rather than code written into it: caching in memory or Redis, IAM user filtering, Analytics Manager query passthrough, key-value web storage. Adding one requires reloading and rebuilding the API before it takes effect.

    Create and deploy an API→

    From a template or from your own NodeJS code.

    API editor interface→

    Version, build and deploy from the low-code editor.

    API extensions list→

    The extensions available to a deployed API.

    Go further

    If you need training or technical assistance to implement our solutions, contact your sales representative or click on this link to get a quote and ask our Professional Services experts for a custom analysis of your project.

    Ask questions, give your feedback and interact directly with the team building the Data Platform on the dedicated Discord channel.

    If you need support with your OVHcloud services, create a request in our Help Centre.

    Join our community of users.