HostingSubscriptionGet

With this function, details about a hosting subscription can be queried.

Request

Field

Type

RegExp

Null?

Description

auth

AuthData

no

Authentication data

subscriptionname

string

^[a-z][a-z0-9_-]{0,63}$

no

Subscription name

Response

Field

Type

Null?

Description

hostname

string

yes

Name of the server on which the hosting subscription is set up

customerid

string

yes

ID of the customer whom this subscription is assigned to (NULL: “My Hosting”)

plan

string

yes

Name of the hosting plan

maxcustomers

integer

yes

Maximum number of customers for resellers (NULL: no reseller subscription, -1: unlimited)

maxusers

integer

no

Maximum number of users (-1: unlimited)

webspace

integer

yes

Web space (MB) (NULL: no web space, -1: unlimited)

ssi

integer

no

SSI (Server-Side Includes) allowed (0: no, 1: yes)

php

integer

no

PHP allowed (0: no, 1: suPHP, 2: FastCGI, 3: mod_php, 4: FPM)

cgi

integer

no

CGI allowed (0: no, 1: yes)

ssl

integer

no

SSL (HTTPS) allowed (0: no, 1: yes, 2: yes (with certificate management))

cronjobs

integer

no

Number of cron jobs (-1: unlimited)

apps

integer

no

Number of installable web applications (-1: unlimited)

ftpaccounts

integer

no

Number of FTP accounts (-1: unlimited)

shellaccess

integer

no

Shell access allowed (0: no, 1: scponly/sftp, 2: bash)

databases

integer

no

Number of databases (-1: unlimited)

subdomains

integer

no

Number of subdomains (-1: unlimited)

extdomains

integer

no

Number of external domains (-1: unlimited)

mailserver

string

yes

Mail server name (NULL if not yet assigned)

mailboxes

integer

no

Number of mailboxes (-1: unlimited)

mailaddrs

integer

no

Number of e-mail addresses (-1: unlimited)

mailquota

integer

no

E-Mail storage size (MB) (-1: unlimited)

traffic

integer

no

IP traffic limit (-1: unlimited)

logfilter4

integer

no

IPv4 address filtering in access.log (number of bytes to be filtered; 0-4)

logfilter6

integer

no

IPv6 address filtering in access.log (number of bytes to be filtered; 0-16)

comment

string

yes

Comment

domains

HostingSubscriptionDomain[]

yes

Assigned domains

databaseList

HostingDatabase[]

yes

Databases

mailboxList

string[]

yes

List of mailboxes, details can be queried with HostingMailboxGet (since v2.10)

locked

integer

no

Locked/suspended services (bit mask: 0: no services locked, 1: webspace, 2: e-mail, 4: FTP)

locktype

integer

no

Lock type (1: locked, 2: suspended)

created

string

yes

Timestamp when subscription has been created

modified

string

yes

Timestamp of last modification of this subscription

phpini

PhpIniSetting[]

yes

Differing php.ini settings

usage

UsageStats

yes

Usage statistics - if available (since v2.10)

Domain name list (HostingSubscriptionDomain[])

Field

Type

Null?

Description

name

string

no

Domain name

subdomains

HostingSubscriptionSubdomain[]

yes

List of subdomains

Subdomain list (HostingSubscriptionSubdomain[])

Field

Type

Null?

Description

name

string

no

Subdomain name

http

integer

yes

Web configuration: NULL = no HTTP; 0 = webspace disabled, 1 = webspace, 2 = redirect (301), 3 = redirect (302), 4 = proxy, 5 = web application (AppInstaller), 6 = SSL redirect, 7 = website builder

httpDest

string

yes

Webspace destination (depending on field http), e.g. DocRoot, redirect URL, app name, …

https

integer

yes

Web configuration for SSL: NULL = no HTTPS; all other: see http

httpsDest

string

yes

Webspace destination (depending on field https), e.g. DocRoot, redirect URL, app name, …

mail

integer

no

E-Mail enabled with this subdomain? (1 = yes)

phpCode

string

yes

if PHP is enabled: show configured PHP version code, e.g. php73 (since v2.10)

phpVersion

string

yes

if PHP is enabled: show configured PHP version number, e.g. 7.3.20 (since v2.10)

Database list

Field

Type

Null?

Description

type

string

no

Database type (MySQL)

server

string

no

Name of database server

name

string

no

Database name

login

string

no

Database login

php.ini settings (PhpIniSetting)

Field

Type

Null?

Description

option

string

no

Name of php.ini setting

value

string

no

Configured value

default

string

yes

Default value (read-only)

Usage statistics (UsageStats)

Field

Type

Null?

Description

webspace

integer

yes

Webspace actually in use (MB)

webtraffic

integer

yes

Webspace traffic in current month (MB)

mailboxes

integer

yes

Number of configured POP3/IMAP mailboxes

mailcount

integer

yes

Number of e-mails in all mailboxes

mailspace

integer

yes

Mailspace actually in use (MB)

mail24h

integer

yes

Number of mails sent and received in the last 24 hours


Last updated on Oct 21, 2020.
next: LiveConfigVersion
previous: HostingSubscriptionEdit