Vultr DocsLatest Content

How to Enable Vultr API Access for Users

Updated on April 22, 2025

Application Programming Interface (API) access allows users to access the Vultr account programmatically. The Vultr API works with various clients, such as the Linux cURL command, Vultr CLI, and modern programming language libraries.

Follow this guide to enable API access for users using the Vultr Customer Portal, API, or CLI.

  • Vultr Customer Portal
  • Vultr API
  • Vultr CLI

  1. Navigate to Account and select Users under OTHER.

  2. Select the user from the list and click the Edit User icon.

  3. Click Enable API under User API Key.

  1. Send a GET request to the Get Users endpoint and note the target user ID.

    console 
    $ curl "https://api.vultr.com/v2/users" \
    -X GET \
    -H "Authorization: Bearer ${VULTR_API_KEY}"

  2. Send a PATCH request to the Update User endpoint and specify the user ID to enable API access for the target user.

    console 
    $ curl "https://api.vultr.com/v2/users/{user-id}" \
    -X PATCH \
    -H "Authorization: Bearer ${VULTR_API_KEY}" \
    -H "Content-Type: application/json" \
    --data '{
        "api_enabled" : true     
    }'

    Visit the Update User endpoint to view additional attributes to add to your request.

  1. List all users and note the target user ID.

    console 
    $ vultr-cli users list

  2. Enable API access for the target user by specifying the user ID.

    console 
    $ vultr-cli users update <user-id> \
--api-enabled="true"

    Run vultr-cli users update --help to view additional available options.