How to Enable Vultr API Access for Users

Updated on 18 August, 2026

Enable API access for an organization user in Vultr IAM so the user can authenticate to the Vultr API using their own API key and account credentials.


API access allows a user to interact with the Vultr account programmatically through the Vultr API, Vultr CLI, or other API clients. Enabling API access for a user permits that user to authenticate requests using their own API key.

Follow this guide to enable API access for a user using the Vultr API or the Vultr CLI.

Note
Use a root user account or a user with the Manage Users permission on the organization.
  • Vultr API
  • Vultr CLI
  1. Send a GET request to the List Users endpoint to retrieve all users and note the target user's 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 to enable API access for the user. Replace {user-id} with the id from the previous step.

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

    A successful update returns an HTTP 202 Accepted response.

  3. Send a GET request to the Get User endpoint to retrieve the user details. Replace {user-id} with the user id.

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

    Verify that api_enabled shows true.

  1. List all users and note the target user's 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.

Comments