Latest Content

How to Create an Application Profile

Updated on 05 August, 2026

Create a Vultr Marketplace application profile using the Vultr Console or Vultr API to register a new app and begin configuring it for publication on Vultr.

An application profile captures information about your application, such as its name, operating system, and a short description. Vultr uses this profile to populate the app's entry in the Marketplace once it's public.

This guide explains how to create an application profile using the Vultr Console or the Vultr API.

  • Vultr Console
  • Vultr API

  1. Click Marketplace in the Vultr Console's left-hand menu.

  2. Click the Create Application button to open the app creation form.

  3. Fill in the data fields under General Information to describe your app.

    • App Name is the short name of your application.
    • App Name ID Format is a URL-friendly identifier for your app. This field is not generated automatically. Enter it yourself.
    • Repo URL is your repository URL.
    • Support Email is an address customers can use to contact you for help.
    • Support URL is a link to your support web page.
    • Operating System should include the distribution and version number.
    • Description is a one-line description of your application.

  4. Enter your Readme content in the Write tab of the Readme editor, in Markdown format. Use the Preview tab to check how it renders, or the Markdown Tutorial tab for formatting help.

    The Readme information is visible to the public on your app's marketing page in the General Information tab, like this example for Minecraft. Attach images by dragging and dropping them or pasting from the clipboard. Uploading through the editor stores them in Vultr Object Storage. For security reasons, outside images are not displayed if you link to them directly.

    See our Markdown formatting tips for the Readme and App Instructions.

  5. Click the Add App button. The Vultr Console returns to the Marketplace Applications list.

Send a POST request to the Create Marketplace App endpoint to create the application profile. Replace APP-NAME, APP-NAME-ID-FORMAT, and APP-DESCRIPTION with your values.

Although the API reference doesn't mark name_id_format as required, omitting it returns a 422 error (`app name id format` too short must be 3 - 36 characters). Always supply a lowercase, hyphenated identifier between 3 and 36 characters, such as my-app-name.

console 
$ curl "https://api.vultr.com/v2/marketplace/apps" \
    -X POST \
    -H "Authorization: Bearer ${VULTR_API_KEY}" \
    -H "Content-Type: application/json" \
    -d '{
        "name": "APP-NAME",
        "name_id_format": "APP-NAME-ID-FORMAT",
        "description": "APP-DESCRIPTION",
        "os": "Linux",
        "support_url": "SUPPORT-URL",
        "support_email": "SUPPORT-EMAIL",
        "readme": "README-MARKDOWN"
    }'

A successful request returns an HTTP 201 Created response with the new app's id. Note this id. The rest of the Marketplace platform documentation uses it to identify the app. The request body also accepts repo_url, public_url_slug, deployable_on_vps, deployable_on_bm, deployable_on_gpu_compute, deployable_on_gpu_workstation, min_cpu_core, min_mem_mb, and category_ids.

Comments