{"id":222,"date":"2021-07-23T12:25:47","date_gmt":"2021-07-23T12:25:47","guid":{"rendered":"https:\/\/ssdsunucum.com\/blog\/backup-tarball-contents\/"},"modified":"2021-07-23T12:25:47","modified_gmt":"2021-07-23T12:25:47","slug":"backup-tarball-contents","status":"publish","type":"post","link":"https:\/\/ssdsunucum.com\/blog\/backup-tarball-contents\/","title":{"rendered":"Backup Tarball Contents"},"content":{"rendered":"<\/p>\n
\n
\n
\n

Valid for versions 92 through the latest version<\/em><\/p>\n<\/div>\n

\n

Version:<\/h4>\n

82<\/h4>\n

84<\/h4>\n

88<\/h4>\n

92<\/h4>\n<\/div><\/div>\n
\n

Overview<\/h2>\n
\n
Warning:<\/div>\n
\n

cPanel & WHM does not<\/strong> recommend using this file as an integration end point. The contents of this file can change at any time.<\/p>\n<\/p><\/div>\n<\/div>\n

When you create a backup, the system creates a tarball (.tar.gz<\/code>) file, which contains compressed versions of an account\u2019s files. The system uses the USERNAME.tar.gz<\/code> file format, where USERNAME<\/code> is the cPanel account\u2019s username. To view the contents of this file, you can:<\/p>\n

    \n
  • Download the tar.gz<\/code> file and extract its contents.<\/li>\n
  • On the command line, use the tar -tvf USER.tar.gz<\/code> command, where USER<\/code> is the account username. This displays all of the backup file\u2019s contents. It does not extract the file\u2019s contents.<\/li>\n<\/ul>\n
    \n
    Note:<\/div>\n
    \n

    The backup process runs as the cPanel user for whom it backs up data. The system includes all of the files the account owns in the backup file. It also includes any files that the account does not own but can access in the backup file. However, the system will not back up any files the account does not<\/strong> own and cannot<\/strong> access.<\/p>\n<\/p><\/div>\n<\/div>\n

    Create a backup in WHM<\/h4>\n

    You can create an account backup file in WHM with one of the following methods:<\/p>\n

      \n
    • In WHM\u2019s Backup Configuration<\/em> interface (WHM >> Home >> Backup >> Backup Configuration<\/em>).<\/li>\n
    • Use WHM\u2019s backup<\/code> script.<\/li>\n
    • Use WHM API 1\u2019s Backup functions.<\/li>\n<\/ul>\n

      Create a backup in cPanel<\/h4>\n

      You can create an account backup file in cPanel with one of the following methods:<\/p>\n

        \n
      • In cPanel\u2019s Backup<\/em> interface (cPanel >> Home >> Files >> Backup<\/em>).<\/li>\n
      • Use UAPI\u2019s Backup functions.<\/li>\n<\/ul>\n

        Directories<\/h2>\n

        The following entries are the file directories in an account\u2019s backup file:<\/p>\n

        authnlinks<\/h3>\n

        The \/authnlinks<\/code> directory contains the account\u2019s external authentication data. This directory only appears if the account uses external authentication.<\/p>\n

        apache_tls<\/h3>\n

        The \/apache_tls<\/code> directory contains the account\u2019s domain files. The files in this directory contain the private keys and SSL certificates for each domain that exists on the account.<\/p>\n

        bandwidth<\/h3>\n

        The system stores bandwidth information in the bandwidth.json<\/code> file. The system creates the \/bandwidth<\/code> directory in the backup file, but does not store any data in this directory.<\/p>\n

        bandwidth_db<\/h3>\n

        The system stores bandwidth information in the bandwidth_db.json<\/code> file. The system creates the \/bandwidth_db<\/code> directory in the backup file, but does not<\/strong> store any data in this directory.<\/p>\n

        counters<\/h3>\n

        The \/counters<\/code> directory contains a copy of any file the account owns within the \/var\/cpanel\/Counters\/<\/code> directory. Each of these files contains the current count for the webpage hit counters. For example, the USER.dat<\/code> file, where USER<\/code> is the account\u2019s username.<\/p>\n

        cp<\/h3>\n

        The \/cp<\/code> directory contains the account\u2019s user file that exists in the \/var\/cpanel\/users<\/code> directory. This file contains the account\u2019s information and account settings.<\/p>\n

        cron<\/h3>\n

        The \/cron<\/code> directory contains the account\u2019s cron<\/code> table file data.<\/p>\n

        ccs<\/h3>\n

        The \/ccs<\/code> directory contains the account\u2019s Calendar and Contacts Server (CCS) plugin data, if it exists.<\/p>\n

        dnssec_keys<\/h3>\n

        The \/dnssec_keys<\/code> directory contains the DNSSEC keys for all of the account\u2019s domains. The system creates a directory for each domain, in which the system copies the domain\u2019s DNSSEC key files. The system stores the DNSSEC key files in keytag_keytype.key<\/code> format, where keytag<\/code> represents the key\u2019s tag ID, and keytype<\/code> represents the type of DNSSEC key.<\/p>\n

        dnszones<\/h3>\n

        The \/dnszones<\/code> directory contains copies of the account\u2019s DNS zone files. The system stores these files in DOMAIN.db<\/code> format, where DOMAIN<\/code> is the account\u2019s domain.<\/p>\n

        domainkeys<\/h3>\n

        The \/domainkeys<\/code> directory contains the account\u2019s private<\/code> and public<\/code> domain key files. The private<\/code> file contains the private keys for each domain that exists on the cPanel account. The public<\/code> file contains the public keys for each domain that exists on the cPanel account.<\/p>\n

        homedir<\/h3>\n

        The \/homedir<\/code> directory contains a copy of the account\u2019s \/home<\/code> directory. The system creates this file with the getpwnam<\/code> command. This directory contains the contents of the account\u2019s \/home<\/code> directory.<\/p>\n

        httpfiles<\/h3>\n

        The \/httpfiles<\/code> directory contains the account\u2019s custom virtualhost templates.<\/p>\n

        ips<\/h3>\n

        The \/ips<\/code> directory contains the related_ips<\/code> file. This file contains the IPv6 addresses that exist on the account\u2019s server.<\/p>\n

        locale<\/h3>\n

        The \/locale<\/code> directory contains an account\u2019s custom locale.<\/p>\n

        logs<\/h3>\n

        The \/logs<\/code> directory contains copies of the account\u2019s log files in the \/usr\/local\/apache\/domlogs<\/code> directory. These files contain data tracked by the the log file.<\/p>\n

        mm<\/h3>\n

        The \/mm<\/code> directory contains the account\u2019s Mailman mailing list files. Each mailing list has its own subdirectory in this directory.<\/p>\n

        mma<\/h3>\n

        The \/mma<\/code> directory contains all of the account\u2019s domains\u2019 Mailman files. The system divides the copied files into subdirectories that correspond to each type of mailing list:<\/p>\n

          \n
        • pub\/<\/code> \u2014 This directory contains all of the account\u2019s domains\u2019 Mailman files from the \/usr\/local\/cpanel\/3rdparty\/mailman\/archives\/public<\/code> directory.<\/li>\n
        • priv\/<\/code> \u2014 This directory contains all of the account\u2019s domains\u2019 Mailman files from the \/usr\/local\/cpanel\/3rdparty\/mailman\/archives\/private<\/code> directory.<\/li>\n<\/ul>\n

          mms<\/h3>\n

          The \/mms<\/code> directory contains files from the account\u2019s \/usr\/local\/cpanel\/3rdparty\/mailman\/suspended.lists<\/code> directory.<\/p>\n

          mysql<\/h3>\n

          The \/mysql<\/code> directory contains the account\u2019s MySQL\u00ae dumps for any of its MySQL databases. It stores these files in USER_database.sql<\/code> format, where USER<\/code> is the account\u2019s username.<\/p>\n

          mysql-timestamps<\/h3>\n

          The \/mysql-timestamps<\/code> directory contains log files that state when the account created a MySQL database. It stores the files in .txt<\/code> file format. These files contain the MySQL database creation timestamp in Unix time format.<\/p>\n

          psql<\/h3>\n

          The \/psql<\/code> directory contains the account\u2019s PostgreSQL\u00ae database files, in .tar<\/code> file format. It also contains the following files:<\/p>\n

            \n
          • 1psql_users.sql<\/code> \u2014 This file contains all of the account\u2019s PostgreSQL users.<\/li>\n
          • psql_grants.sql<\/code> \u2014 This file contains all of the account\u2019s PostgreSQL grants.<\/li>\n<\/ul>\n

            resellerconfig<\/h3>\n

            The \/resellerconfig<\/code> directory contains a reseller account\u2019s reseller<\/code> file. The reseller<\/code> file contains data from the account\u2019s \/var\/cpanel\/resellers<\/code> file, which includes the account\u2019s username and all of the account\u2019s access control list (ACL) privileges. The \/resellerconfig<\/code> directory also contains the resellers-nameservers<\/code> file, which contains the account\u2019s entry in the \/var\/cpanel\/resellers-nameservers<\/code> file.<\/p>\n

            resellerfeatures<\/h3>\n

            The \/resellerfeatures<\/code> directory contains a reseller account\u2019s custom feature lists.<\/p>\n

            resellerpackages<\/h3>\n

            The \/resellerpackages<\/code> directory contains a reseller account\u2019s custom packages.<\/p>\n

            ssl<\/h3>\n

            The contents of the \/ssl<\/code> directory exist in the backup file\u2019s \/homedir\/ssl<\/code> directory.<\/p>\n

            sslcerts<\/h3>\n
            \n
            Note:<\/div>\n
            \n

            The contents of this directory exist in the backup file\u2019s \/homedir\/ssl<\/code> directory.<\/p>\n<\/p><\/div>\n<\/div>\n

            The \/sslcerts<\/code> directory contains the certificate files for each of the account\u2019s domains. This directory contains the following files, where where DOMAIN<\/code> is the account\u2019s domain name:<\/p>\n

              \n
            • DOMAIN.crt<\/code> \u2014 The domain certificate file.<\/li>\n
            • DOMAIN.cabundle<\/code> \u2014 This file is a copy of the domain\u2019s Certificate Authority (CA) bundle.<\/li>\n
            • DOMAIN.csr<\/code> \u2014 This file is a copy of the certificate-signing request (CSR). These system copies these files from the following directories:\n
                \n
              • \/usr\/share\/ssl\/certs<\/code><\/li>\n
              • \/etc\/ssl\/certs<\/code><\/li>\n
              • \/var\/cpanel\/ssl\/installed\/certs<\/code><\/li>\n
              • \/usr\/local\/ssl\/certs<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n

                sslkeys<\/h3>\n
                \n
                Note:<\/div>\n
                \n

                The contents of this directory exist in the backup file\u2019s \/homedir\/ssl<\/code> directory.<\/p>\n<\/p><\/div>\n<\/div>\n

                The \/sslkeys<\/code> directory contains all of the SSL keys for the account\u2019s domains. The system copies this file in DOMAIN.key<\/code> format, where DOMAIN<\/code> is the account\u2019s domain name.<\/p>\n

                suspended<\/h3>\n

                The \/suspended<\/code> directory contains a copy of the file in the account\u2019s \/var\/cpanel\/suspended<\/code> directory. The system copies the files in USER<\/code> or USER.lock<\/code> format, where USER<\/code> is the account username. Each file contains the reason for the account suspension, if one exists.<\/p>\n

                suspendinfo<\/h3>\n

                The \/suspendinfo<\/code> directory contains a copy of the files in the account\u2019s \/var\/cpanel\/suspendinfo<\/code> directory.<\/p>\n

                userconfig<\/h3>\n

                The \/userconfig<\/code> directory contains a copy of the files in the \/var\/cpanel\/userconfig<\/code> directory. This file contains symlinks from the account\u2019s public_html<\/code> directory.<\/p>\n

                userdata<\/h3>\n

                The \/userdata<\/code> directory contains the user data of the account\u2019s subdomain or domain. The system copies files in this directory from the \/var\/cpanel\/userdata\/USER<\/code> directory, where USER<\/code> is the account\u2019s username.<\/p>\n

                va<\/h3>\n

                The \/va<\/code> directory contains any of the account\u2019s autoresponders. The system copies this file from the \/etc\/valiases\/<\/code> directory.<\/p>\n

                vad<\/h3>\n

                The \/vad<\/code> directory contains a copy of the account\u2019s virtual domain aliases. The system copies this file from the \/etc\/vdomainaliases<\/code> directory.<\/p>\n

                vf<\/h3>\n

                The \/vf<\/code> directory contains a copy of the user\u2019s Exim filters. The system creates copies of the filters that the user owns from the \/etc\/vfilters<\/code> directory.<\/p>\n

                Files without a directory<\/h2>\n

                The following are files in the tarball that do not exist in a directory:<\/p>\n

                addons<\/h3>\n

                The addons<\/code> file contains a hash of the account\u2019s addon domains and their relative subdomains.<\/p>\n

                autossl.json<\/h3>\n

                The autossl.json<\/code> file contains the account\u2019s AutoSSL run preferences. This file also contains any AutoSSL run restrictions set by the system administrator.<\/p>\n

                bandwidth_db.json<\/h3>\n

                The bandwidth_db.json<\/code> file contains the account\u2019s bandwidth data information.<\/p>\n

                bandwidth_db.data.json<\/h3>\n

                The bandwidth_db.data.json<\/code> file contains the account\u2019s bandwidth usage data.<\/p>\n

                digestshadow<\/h3>\n

                The digestshadow<\/code> file contains the passwords for the account\u2019s DAV digest authentication for cPanel\u2019s WebDisk<\/em> feature (cPanel >> Home >> Files >> Web Disk<\/em>).<\/p>\n

                has_sslstorage<\/h3>\n

                The has_sslstorage<\/code> file contains a touch file that indicates the account uses WHM\u2019s SSL Storage Manager<\/em> feature (WHM >> Home >> SSL\/TLS >> SSL Storage Manager<\/em>). It stores this file in crtindex.txt<\/code> format.<\/p>\n

                homedir_paths<\/h3>\n

                The homedir_paths<\/code> file contains the full path to the account\u2019s \/home<\/code> directory.<\/p>\n

                mysql.sql<\/h3>\n

                The mysql.sql<\/code> file contains the account\u2019s MySQL database grants.<\/p>\n

                mysql_host_notes.json<\/h3>\n

                The mysql_host_notes.json<\/code> file contains the user-provided description information for the account\u2019s MySQL database hosts, if available.<\/p>\n

                nobodyfiles<\/h3>\n

                The nobodyfiles<\/code> file contains a list of files in the account\u2019s \/home<\/code> directory that the nobody<\/code> system user owns.<\/p>\n

                pds<\/h3>\n

                The pds<\/code> file contains a list of the account\u2019s parked domains (aliases).<\/p>\n

                proftpdpasswd<\/h3>\n

                The proftpdpasswd<\/code> file contains a copy the account\u2019s ProFTPd file in the \/etc\/proftpd<\/code> directory.<\/p>\n

                quota<\/h3>\n

                The quota<\/code> file contains the account\u2019s quota size, in bytes.<\/p>\n

                sds<\/h3>\n

                The sds<\/code> file contains a list of the account\u2019s subdomains.<\/p>\n

                sds2<\/h3>\n

                The sds2<\/code> file contains a hash of subdomains and their relative document roots.<\/p>\n

                shadow<\/h3>\n

                The shadow<\/code> file contains a copy of the account\u2019s password that the getpwnam<\/code> command returns.<\/p>\n

                shell<\/h3>\n

                The shell<\/code> file contains the account\u2019s login shell.<\/p>\n

                version<\/h3>\n

                The version<\/code> file contains the account\u2019s pkgacct<\/code> version number and its archive version number.<\/p>\n

                webcalls.json<\/h3>\n

                The webcalls.json<\/code> file contains the account\u2019s web call data. For example, the account\u2019s dynamic DNS domains.<\/p>\n<\/p><\/div>\n","protected":false},"excerpt":{"rendered":"

                Valid for versions 92 through the latest version Version: 82 84 88 92 Overview Warning: cPanel & WHM does not recommend using this file as an integration end point. The contents of this file can change at any time. When you create a backup, the system creates a tarball (.tar.gz) file, which contains compressed versions …<\/p>\n","protected":false},"author":1,"featured_media":223,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/222"}],"collection":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/comments?post=222"}],"version-history":[{"count":0,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/posts\/222\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media\/223"}],"wp:attachment":[{"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/media?parent=222"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/categories?post=222"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ssdsunucum.com\/blog\/wp-json\/wp\/v2\/tags?post=222"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}