Update the display name of an existing organization on Vultr. Modify organizational details through the Vultr IAM API or the Vultr Console interface.
Updating an organization name changes the display name associated with your organization across the Vultr platform. This can be useful when your team or company undergoes rebranding or when you need to distinguish between multiple organizations on your account.
Follow this guide to update an organization name using the Vultr Console, the Vultr API, or Terraform.
Log in to the Vultr Console.
Click the organization name in the top navigation bar.
Click Manage Organization.
On the Settings tab, click the Edit icon next to the organization name.
In the Edit Organization panel, update the Name field with the new organization name.
Click Save Changes.
The organization name is updated across the Vultr Console.
Send a GET request to the List Organizations endpoint to retrieve all organizations associated with your account.
$ curl "https://api.vultr.com/v2/organizations" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Note the id of the organization you want to rename.
Send a GET request to the Read Organization endpoint to retrieve the current organization details. Replace {organization-id} with the id you retrieved in the previous step.
$ curl "https://api.vultr.com/v2/organizations/{organization-id}" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Send a PUT request to the Update Organization endpoint to change the organization name. Replace NEW-ORGANIZATION-NAME with the desired name for your organization.
$ curl "https://api.vultr.com/v2/organizations/{organization-id}" \
-X PUT \
-H "Authorization: Bearer ${VULTR_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "NEW-ORGANIZATION-NAME"
}'
The response confirms the organization name has been updated.
Send a GET request to the Read Organization endpoint to retrieve the organization details.
$ curl "https://api.vultr.com/v2/organizations/{organization-id}" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Verify that the name field reflects the new organization name.
To manage an organization with Terraform, you must first import the existing organization into your state. An account can only belong to one organization, so Terraform cannot create a second one.
Ensure the Vultr Terraform provider is configured in your Terraform project.
Retrieve your organization's ID and current type.
$ curl "https://api.vultr.com/v2/organizations" \
-X GET \
-H "Authorization: Bearer ${VULTR_API_KEY}"
Note the id and type values. The type field in the API response must match exactly what you set in the Terraform configuration.
Define the organization resource. Replace CURRENT-ORG-NAME with the current organization name and CURRENT-TYPE with the type returned by the API.
resource "vultr_organization" "my_org" {
name = "CURRENT-ORG-NAME"
type = "CURRENT-TYPE"
}
Import the existing organization into Terraform state. Replace ORG-ID with the id you retrieved.
$ terraform import vultr_organization.my_org ORG-ID
Verify that the output shows Import successful!.
Update the name field in the organization resource configuration with the new organization name.
$ nano organizations.tf
Apply the configuration.
$ terraform apply
Verify that the output shows vultr_organization.my_org: Modifications complete.