Netim Direct
Updated on 8 January 2024

StructWebHostingInfo

1 Description
2 Variables
3 Specifications of the WEB array
4 Specifications of the VHOSTS array
5 Specifications of the SSL_CERTIFICATES array
6 Specifications of the PROTECTED_DIRECTORIES array
7 Specifications of the DATABASES array
8 Specifications of the DATABASE_USERS array
9 Specifications of the FTP_USERS array
10 Specifications of the CRON_TASKS array
11 Specifications of the MAIL array
12 Specifications of the DOMAIN_MAIL array
13 Specifications of the MAILBOXES array
14 Specifications of the MAIL_FORWARDS array
15 Linked functions

Description

This object stores the information of a hosting.

Variables

REQUIRED

  • id string
    Hosting ID.
  • domain string
    Fully qualified domain name of the hosting’s main vhost.
  • offer string
    Hosting product ID (See Web hosting products).
  • dateCreate string
    Registration date (YYYY-MM-DD).
  • dateExpiration string
    Expiration date (YYYY-MM-DD).
  • dateMaxRenew string
    Maximum renewal date before the deletion (YYYY-MM-DD).
  • status string (255)
    Current status
  • autoRenew integer (1)
    Is the hosting set to be autorenewed ? (0 or 1).

OPTIONAL

  • WEB array
    Data concerning the web service.
  • VHOSTS array
    Data concerning the virtual hosts.

  • SSL_CERTIFICATES array
    Data concerning the certificates.

  • PROTECTED_DIRECTORIES array
    Data concerning the protected directories.
  • DATABASES array
    Data concerning the databases.
  • DATABASE_USERS array
    Data concerning the database users.
  • FTP_USERS array
    Data concerning the FTP users.
  • CRONT_TASKS array
    Data concerning the crontab.
  • MAIL array
    Data concerning the email addresses.
  • DOMAIN_MAIL array
    Data concerning the domains mail.

Specifications of the WEB array

  • urlFTP string (255)
    URL of the FTP service.

  • diskUsage double
    Current storage used by web service at the time of calculation (not real-time).

  • maxDiskUsage double
    Total storage allowed for web service n the package.

  • percentDiskUsage double
    Percentage of storage used at the time of calculation (not real-time) relative to maxDiskUsage.

  • nbVhosts integer
    Number of active websites (vHost).

  • maxNbVhosts integer
    Number of allowed websites in the package.

  • nbDatabases integer
    Number of active databases.

  • maxNbDatabase integer
    Number of allowed databases in the package.

  • status string
    Status of the web service for the whole hosting.

Specifications of the VHOSTS array

  • fqdn string (255)
    Fully Qualified Domain Name.

  • isMainVhost integer (1)
    Main vHost of the hosting (0/1).

  • staticEngine string
    Static engine.

  • dynamicEngine string
    Dynamic engine.

  • PHPVersion string
    Version of PHP.

  • ipV4 string
    IP address (V4) allocated to the vhost.

  • ipV6 string
    IP address (V6) allocated to the vhost.

  • urlPreview string (255)
    URL to preview the website.

  • webApplicationFirewall string
    Status of the application firewall (“on”, “off”, “log”).

  • linkedSslCertificate string
    SSL certificate.

  • diskUsage double
    Storage used for content at the time of calculation (Not real-time).

  • logsDiskUsage double
    Storage used for logs at the time of calculation (Not real-time).

  • status string
    Status of the web service.

  • ALIASES array (string)
    Domain aliases.

  • DEFAULT_PHP_PARAMETERS array (key => value)
    PHP parameters set by default.

  • SPECIFIC_PHP_PARAMETERS array (key => value)
    PHP parameters set by user.

Specifications of the SSL_CERTIFICATES array

  • name string
    Name.

  • LINKED_VHOSTS array
    List of vhosts covered by the certificate.

Specifications of the PROTECTED_DIRECTORIES array

  • vhost string
    vHost of the directory.

  • path string (255)
    Path of the directory.

  • authname string
    Realm to be used in the authentication.

  • users array (string)
    List of users.

Specifications of the DATABASES array

  • name string
    Name.

  • SQLVersion string
    Version of the database engine.

  • localSQLServer string
    Host name to connect locally from the vhost.

  • remoteSQLServer string
    Host name to connect remotely.

  • phpMyAdmin string
    URL to connect phpMyAdmin interface.

  • diskUsage double
    Disk usage at the time of calculation (not real-time).

  • maxDiskUsage double
    Total storage allowed for the database in the package.

  • percentDiskUsage double
    Percentage of storage used at the time of calculation (not real-time) relative to maxDiskUsage.

  • status string
    Current status.

  • LINKED_USERS array (string)
    List of users.

Specifications of the DATABASE_USERS array

  • login string
    Login.

  • localAccess string
    Rights to access locally the database: “read/write” / “readOnly” / “none”.

  • remoteAccess string
    Rights to access locally the database: “read/write” / “readOnly” / “none”.

  • status string
    Current status.

  • LINKED_DATABASES array (string)
    List of databases.

Specifications of the FTP_USERS array

  • login string
    Login.

  • mainUser integer
    Main FTP user of the hosting (0/1).

  • rootDirectory string
    Path to the home.

  • status string
    Current status.

Specifications of the CRON_TASKS array

  • id string
    Task ID.

  • vhost string
    vHost on which the task is executed.

  • path string
    Path to the file to be executed.

  • mm string
    Minutes (00-59).

  • hh string
    Hours (00-23).

  • jj string
    Day (01-31).

  • mmm string
    Month (01-12).

  • jjj string
    Day in the week (1-7).

  • logType string
    Logging method (“FILE” / “MAIL” / “NONE”).

  • logTarget string
    Target of the log (Must match the logType)

  • active integer
    Activation status (0/1).

  • status string
    Current status.

Specifications of the MAIL array

  • diskUsage double
    Current storage used by email service.

  • percentDiskUsage double
    Percentage of storage used relative to maxDiskUsage.

  • diskReserved double
    Current storage reserved by the mailboxes quota.

  • percentDiskReserved double
    Percentage of storage reserved relative to maxDiskUsage.

  • maxDiskUsage double
    Total storage allowed in the package for email service.

  • nbMailboxes integer
    Number of active mailboxes.

  • maxNbMailboxes integer
    Number of allowed mailboxes in the package.

  • status string
    Current status.

  • urlWebmail string
    URL of the webmail.

Specifications of the DOMAIN_MAIL array

  • domain string
    domain mail.

  • ALIASES array (string)
    List of domain aliases.

  • MAILBOXES array
    Data concerning mailboxes.

  • MAIL_FORWARDS array
    Data concerning mail forwards.

  • status string
    Current status (“ok” / “serverDomainMailHold” / “clientDomainMailHold”)

Specifications of the MAILBOXES array

  • mailbox string
    Mailbox.

  • quota double
    Quota allowed for the mailbox (Taken into account in diskReserved of the mail service).

  • diskUsage double
    Current storage used.

  • percentDiskUsage double
    Percentage of storage used relative to quota.

Specifications of the MAIL_FORWARDS array

  • source string
    Source email address

  • DESTINATIONS array (string)
    Recipients.

Linked functions