{"id":215,"date":"2023-06-26T04:36:50","date_gmt":"2023-06-26T04:36:50","guid":{"rendered":"https:\/\/cainhosting.com\/community\/?post_type=ht_kb&p=215"},"modified":"2023-06-26T04:51:14","modified_gmt":"2023-06-26T04:51:14","slug":"directadmin-api-bash-script-to-create-user-account","status":"publish","type":"ht_kb","link":"https:\/\/cainhosting.com\/community\/knowledge-base\/directadmin-api-bash-script-to-create-user-account\/","title":{"rendered":"DirectAdmin bash script to create user account & database."},"content":{"rendered":"
\n
\"\"<\/figure>\n<\/div>\n\n\n

Here CainHosting <\/a>has created a bash script<\/a> to work with the DirectAdmin API<\/a> to create user accounts, assign packages, assign IP addresses, and also create MySQL database, MySQL user, & MySQL passwords for accounts automatically.<\/p>\n\n\n\n

If you don’t need to create the MySQL automatically, you can delete everything after the section # MySQL Database details<\/strong><\/p>\n\n\n

Parts you need to change:<\/strong><\/span><\/p>\n

# Constants<\/strong><\/p>\n

    \n
  1. DIRECTADMIN_HOSTNAME<\/strong><\/li>\n
  2. DIRECTADMIN_USERNAME<\/strong><\/li>\n
  3. DIRECTADMIN_PASSWORD<\/strong><\/li>\n<\/ol>\n

    # Create the user account<\/strong><\/p>\n

      \n
    1. package=Package_Name<\/strong><\/li>\n
    2. ip=IP_A.D.D.R.E.S.S<\/strong><\/li>\n<\/ol>\n

      The Bash Script<\/h2>\n\n\n
      <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
      #!\/bin\/bash<\/span><\/span>\n<\/span>\n# Constants<\/span><\/span>\nDIRECTADMIN_HOSTNAME<\/span>=<\/span>"<\/span>your DA url<\/span>"<\/span><\/span>\nDIRECTADMIN_PORT<\/span>=<\/span>2222<\/span><\/span>\nDIRECTADMIN_USERNAME<\/span>=<\/span>"<\/span>your DA admin username<\/span>"<\/span><\/span>\nDIRECTADMIN_PASSWORD<\/span>=<\/span>"<\/span>your DA admin password<\/span>"<\/span><\/span>\nDIRECTADMIN_HTTPS<\/span>=<\/span>true<\/span>  <\/span># Set this to true if your DirectAdmin server uses HTTPS<\/span><\/span>\n<\/span>\n# Command line arguments<\/span><\/span>\nUSERNAME<\/span>=<\/span>"<\/span>$1<\/span>"<\/span><\/span>\nPASSWORD<\/span>=<\/span>"<\/span>$2<\/span>"<\/span><\/span>\nEMAIL<\/span>=<\/span>"<\/span>$3<\/span>"<\/span><\/span>\nDOMAIN<\/span>=<\/span>"<\/span>$4<\/span>"<\/span><\/span>\n<\/span>\n# DirectAdmin API URL<\/span><\/span>\nif<\/span> <\/span>[<\/span> <\/span>"<\/span>$DIRECTADMIN_HTTPS<\/span>"<\/span> <\/span>=<\/span> <\/span>true<\/span> <\/span>]<\/span>;<\/span> <\/span>then<\/span><\/span>\n  <\/span>PROTOCOL<\/span>=<\/span>"<\/span>https<\/span>"<\/span><\/span>\nelse<\/span><\/span>\n  <\/span>PROTOCOL<\/span>=<\/span>"<\/span>http<\/span>"<\/span><\/span>\nfi<\/span><\/span>\nAPI_URL<\/span>=<\/span>"<\/span>${<\/span>PROTOCOL<\/span>}<\/span>:\/\/<\/span>${<\/span>DIRECTADMIN_HOSTNAME<\/span>}<\/span>:<\/span>${<\/span>DIRECTADMIN_PORT<\/span>}<\/span>\/CMD_API_ACCOUNT_USER<\/span>"<\/span><\/span>\n<\/span>\n# Create the user account<\/span><\/span>\nRESPONSE<\/span>=<\/span>$(<\/span>curl<\/span> -s -u <\/span>"<\/span>${<\/span>DIRECTADMIN_USERNAME<\/span>}<\/span>:<\/span>${<\/span>DIRECTADMIN_PASSWORD<\/span>}<\/span>"<\/span> -d <\/span>"<\/span>action=create&add=Submit&username=<\/span>${<\/span>USERNAME<\/span>}<\/span>&email=<\/span>${<\/span>EMAIL<\/span>}<\/span>&passwd=<\/span>${<\/span>PASSWORD<\/span>}<\/span>&passwd2=<\/span>${<\/span>PASSWORD<\/span>}<\/span>&domain=<\/span>${<\/span>DOMAIN<\/span>}<\/span>&package=Package_Name&ip=IP_A.D.D.R.E.S.S\u00acify=no<\/span>"<\/span> <\/span>"<\/span>${<\/span>API_URL<\/span>}<\/span>")<\/span><\/span>\n<\/span>\nif<\/span> <\/span>[[<\/span> <\/span>$RESPONSE<\/span> <\/span>==<\/span> <\/span>*<\/span>"<\/span>error=0<\/span>"<\/span>*<\/span> <\/span>]]<\/span>;<\/span> <\/span>then<\/span><\/span>\n  <\/span>echo<\/span> <\/span>"<\/span>User account created successfully.<\/span>"<\/span><\/span>\nelse<\/span><\/span>\n  <\/span>echo<\/span> <\/span>"<\/span>Error creating user account: <\/span>$RESPONSE<\/span>"<\/span><\/span>\nfi<\/span><\/span>\n<\/span>\n# MySQL Database details<\/span><\/span>\nDB_NAME<\/span>=<\/span>"<\/span>$5<\/span>"<\/span><\/span>\nDB_USER<\/span>=<\/span>"<\/span>$6<\/span>"<\/span><\/span>\nDB_PASSWORD<\/span>=<\/span>"<\/span>$7<\/span>"<\/span><\/span>\n<\/span>\n# DirectAdmin API URL for MySQL database creation<\/span><\/span>\nAPI_URL_DB<\/span>=<\/span>"<\/span>${<\/span>PROTOCOL<\/span>}<\/span>:\/\/<\/span>${<\/span>DIRECTADMIN_HOSTNAME<\/span>}<\/span>:<\/span>${<\/span>DIRECTADMIN_PORT<\/span>}<\/span>\/CMD_API_DATABASES<\/span>"<\/span><\/span>\n<\/span>\n# Create the MySQL database<\/span><\/span>\nRESPONSE_DB<\/span>=<\/span>$(<\/span>curl<\/span> -s -u <\/span>"<\/span>${<\/span>DIRECTADMIN_USERNAME<\/span>}<\/span>|<\/span>${<\/span>USERNAME<\/span>}<\/span>:<\/span>${<\/span>DIRECTADMIN_PASSWORD<\/span>}<\/span>"<\/span> -d <\/span>"<\/span>action=create&name=<\/span>${<\/span>DB_NAME<\/span>}<\/span>&user=<\/span>${<\/span>DB_USER<\/span>}<\/span>&passwd=<\/span>${<\/span>DB_PASSWORD<\/span>}<\/span>&passwd2=<\/span>${<\/span>DB_PASSWORD<\/span>}<\/span>"<\/span> <\/span>"<\/span>${<\/span>API_URL_DB<\/span>}<\/span>")<\/span><\/span>\n<\/span>\nif<\/span> <\/span>[[<\/span> <\/span>$RESPONSE_DB<\/span> <\/span>==<\/span> <\/span>*<\/span>"<\/span>error=0<\/span>"<\/span>*<\/span> <\/span>]]<\/span>;<\/span> <\/span>then<\/span><\/span>\n  <\/span>echo<\/span> <\/span>"<\/span>Database created successfully.<\/span>"<\/span><\/span>\nelse<\/span><\/span>\n  <\/span>echo<\/span> <\/span>"<\/span>Error creating database. <\/span>$RESPONSE_DB<\/span>"<\/span><\/span>\nfi<\/span><\/span>\n<\/span><\/code><\/pre><\/div>\n\n\n\n
      How to use the script:<\/h2>\n\n\n\n
      When you input the database name and database username, don’t include username_<\/strong>, this will be populated by the DirectAdmin API.
      <\/p>\n\n\n\n
      Example usage:<\/h3>\n\n\n\n
      <\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
      .\/create_user.sh<\/span> [username] <\/span>[<\/span>password<\/span>]<\/span> <\/span>[<\/span>email<\/span>]<\/span> <\/span>[<\/span>domain<\/span>]<\/span> <\/span>[<\/span>mysqldatabase<\/span>]<\/span> <\/span>[<\/span>mysqluser<\/span>]<\/span> <\/span>[<\/span>db-password<\/span>]<\/span><\/span>\n<\/span><\/code><\/pre><\/div>\n\n\n\n
      How the bash script works.<\/h2>\n
      Before running the script edit # Constants changing the server’s hostname, port number, your DirectAdmin username and password, and whether the server uses HTTPS.<\/p>\n
      Run the script as command line arguments.<\/p>\n
      Sends a request to the DirectAdmin API using the provided info to create the user account, including the username, email, password, domain, package name, IP address, and notification preferences.<\/p>\n
      The script captures the API response.<\/p>\n
      The script also allows creation of a MySQL database by providing the name, username, and password.<\/p>\n
      Sends another request to the DirectAdmin API to create the database with provided information.<\/p>\n
      DirectAdmin: All About API<\/h2>\n
      DirectAdmin has a feature-set which allows you to control almost everything you can via a browser, but using socket based scripts instead. This is called an “API”.<\/p>\n
      There are hundreds of possible API commands. Essentially, anything you can do normally in a browser, you can also do with the API. Just swap CMD_name to CMD_API_name (replace “name” with whatever the browser had), and use the same variables as the browser does running directadmin in debug mode<\/a> ). Search for that CMD_API_name value in the Versions System<\/a><\/p>\n
      for more information.<\/p>\n
      Starting point and main API documentation:
      http:\/\/www.directadmin.com\/api.html<\/a><\/p>\n
      Php communication class:
      http:\/\/forum.directadmin.com\/showthread.php?t=258<\/a>Some API command are listed in the api.html page above, but most only exist in the versions system:
      http:\/\/www.directadmin.com\/search_versions.php?query=CMD_API<\/a>More examples:
      http:\/\/www.directadmin.com\/sample_api.txt<\/a>
      http:\/\/files.directadmin.com\/services\/all\/httpsocket\/examples\/<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
      Here CainHosting has created a bash script to work with the DirectAdmin API to create user accounts, assign packages, assign IP addresses, and also create MySQL database, MySQL user, & MySQL passwords for accounts automatically. If you don’t need to create the MySQL automatically, you can delete everything after the…<\/p>\n","protected":false},"author":1,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"ht-kb-category":[33],"ht-kb-tag":[43,40,44,39,29,41,42],"class_list":["post-215","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-directadmin","ht_kb_tag-automation","ht_kb_tag-bash","ht_kb_tag-create-user-account","ht_kb_tag-directadmin","ht_kb_tag-mysql","ht_kb_tag-ssh","ht_kb_tag-terminal"],"_links":{"self":[{"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb\/215","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/comments?post=215"}],"version-history":[{"count":15,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb\/215\/revisions"}],"predecessor-version":[{"id":232,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb\/215\/revisions\/232"}],"wp:attachment":[{"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/media?parent=215"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb-category?post=215"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/cainhosting.com\/community\/wp-json\/wp\/v2\/ht-kb-tag?post=215"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}