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/app-services-apis-deploy.md.
  • 🇬🇧 English

    • Create and deploy an 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 Platform

    Objective

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

    Project home

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

    API store

    Choose a name for your API, and enable the option auto build. This will download the source code of your API and automatically build it for you. You can also activate auto-deploy right away, or check out down below how to deploy your API manually.

    API settings

    From there, give it a couple of seconds as the creation of the API may take a moment.

    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!

    API building home

    On the home page of your API, you'll find three parts:

    • Monitoring: status of your API once it has been deployed
    • Active: status of your "active" version, that is to say, the one you are currently working on
    • Versions: list of all the versions (also called tags) available in your API
    Project home

    You can see more details about the version you just created using the arrow on the right of it.

    Project home

    Check the activity log by clicking on "Open Console". Since you have activated the auto-build when creating the API, it has already started.

    Project home

    When it is done, you should see a last log "EndBuild success".

    Project home

    To start the deployment, please click on "Deploy".

    Project home

    Deployment starts, and may take a few minutes.

    Project home

    When the deployment is complete, the "Open" button appears.

    Project home

    When you open your API, you now land on this screen.

    To access your API, simply install an application and connect it to the API. You can also use its endpoints live.

    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.