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/getting-started-expose-api.md.
  • 🇬🇧 English

    • Deploy your first API

    An API is crucial as it is the interface between the external world (namely your applications) and the rest of your Project (i.e. your Lakehouse Manager

    Objective

    An API is crucial as it is the interface between the external world (namely your applications) and the rest of your Project (i.e. your Lakehouse Manager and queries). You will have to call this API when building your application, in the next and final tutorial.

    Project home

    Create a new API

    From your Project's home page, click on + inside the API module.

    You will be able to choose between an existing API template from the internal Store, or to import your own code by linking a Git repository.

    Since you're just starting, we've made a simple NodeJS template just for you. Proceed by selecting the only template available: API NodeJS.

    API store

    Choose a name for your API, and enable the option auto build & auto deploy. This will download the source code of your API, automatically build it and deploy it for you.

    API settings

    From there, give it a couple of seconds as the creation of the API may take a moment. Go grab a hot drink ☕ whilst the API finishes its build.

    API building home
    Info

    The Platform uses a blue-green deployment methodology ensuring 100% availability of your data. You can therefore seamlessly create & deploy new versions of your API without risking any downtime!

    When the deployment is complete, the Open button appears.

    API deployed

    When you open your API, you will land on the screen below confirming that your API is alive & healthy. It's that easy! 🎉

    Learn more about your Project APIs

    API open

    The next and final step will consist of creating and deploying your first application on the Platform in under 5 minutes.

    Create your first app

    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.