Update Account Settings via API

This method allows you to update the settings of your DeployHQ account, including name, time zone, and security policies.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/account

HTTP Method

PUT

Supported Parameters

All parameters are wrapped in an account key.

• name - The display name for the account (optional)
• permalink - The account permalink used in the URL (optional)
• time_zone - The default time zone for the account (optional)
• ip_restricted - Whether to restrict access by IP address (optional, boolean)
• two_factor_auth_required - Whether to require two-factor authentication for all users (optional, boolean)
• strong_password_required - Whether to require strong passwords for all users (optional, boolean)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X PUT \
-d '{ \
  "account": { \
    "name": "My Company", \
    "time_zone": "Europe/London", \
    "two_factor_auth_required": true \
  } \
}' \
https://test.deployhq.com/account

Example Response

{
  "name": "My Company",
  "permalink": "zbigw",
  "time_zone": "Europe/London",
  "package": "premium_2020",
  "trialling": false,
  "suspended": false,
  "project_count": 7,
  "project_limit": 48,
  "users_allowed": true
}

Notes

• Only account administrators can update account settings
• Changing the permalink will change the URL used to access your account
• Enabling two_factor_auth_required will require all users to set up two-factor authentication on their next login
• Enabling strong_password_required will enforce strong password requirements for all users