Hosting

Object: Hosting

Properties

| name | type | required | default | description | |------------------------|-------------------------------------------------------------------------------------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | identifier | string | yes | | The identifier you can retrieve the hosting by | | status | string | yes | provisioning | The status of the hosting object | | domain | string | yes | | The domain name in IDN punycode form | | crmId | string | no | | The customer relation management Identifier. String (16) | | domains | array <HostingDomain> | yes | | A list of domains attached to the hosting | | info | object: HostingInfo | yes | | Hosting stats | | options | array <HostingOption> | yes | | A list of Options available on this Hosting object | | package | object: Package | yes | | A Package object describing the attached Package | | server | object: Server | yes | | The Server object this Hosting is attached to | | suspended | object: boolean | yes | | If it is suspended or not | | suspendReason | array <string> | no | | The reason a domain was suspended | | suspendedDomain | object: boolean | yes | | If the domain is suspended or not | | suspendDomainReason | array <string> | no | | The reason a domain was suspended | | renewalDay | integer | yes | | The day of month when this renews | | period | integer | yes | | The interval in unit this is charged | | periodUnit | string | yes | | The interval unit this is charged | | nextRenewal | string | no | | Date when the next renewal transaction should happen (when you are billed for the next period) | | openJobCount | integer | yes | | How many jobs are still open | | openJobs | array <HostingJob> | yes | | A list of jobs that are open for this hosting | | servicePeriod | integer | yes | | The interval in months the service runs for | | serviceStatus | string | yes | | active or cancelled, if the status is cancelled then the hosting will be deleted automatically on the nextServiceRenewalDate | | serviceRenewalMonth | integer | yes | | The the month the service plan should renew if the service period is 12 months | | nextServiceRenewalDate | string | no | | Date when the service renews, it will be deleted on this date if the service status is set to cancelled | | lastMalwareScan | integer | no | | Timestamp when the last malware scan was run by the agent | | created | integer | yes | | Timestamp when this was created | | modified | integer | yes | | Timestamp when this was last modified | | metadata | array | no | | Associative array (or object) string key with value of type string,boolean,integer,float or null. A place to store your * metadata. Although this field is free to use, don't use it to store large amounts of data. Use null to remove a key * from metadata |

Sample JSON

{
  "identifier": "1_aed1f3d95b069d5cdf88ef9d70392d359847e144",
  "status": "active",
  "domain": "example-2021-8-9-14-40-49.com",
  "info": {
    "serverPlan": "basic",
    "pleskUser": "h_00000001",
    "pleskFtpUser": "f_00000001",
    "pleskClientId": 282,
    "pleskHostingId": 235,
    "activeDomains": 1,
    "subdomains": 0,
    "diskspace": 0,
    "databases": 0,
    "traffic": 0,
    "trafficPrevDay": 0
  },
  "options": [
    {
      "name": "letsEncrypt",
      "value": "disabled",
      "arguments": []
    },
    {
      "name": "malwareScanner",
      "value": "disabled",
      "arguments": [1,"m"]
    }
  ],
  "package": {
    "packageId": "basic",
    "type": "plesk",
    "status": "active",
    "spec": [
      {
        "type": "diskspace",
        "value": "1000"
      }
    ],
    "created": 1626272615,
    "modified": 1626272619
  },
  "server": {
    "identifier": "pleskdev",
    "hostname": "pleskdev.yourdomainprovider.net",
    "type": "plesk",
    "status": "active",
    "ips": [
      {
        "address": "213.249.70.50",
        "version": 4
      },
      {
        "address": "2a01:448:1004::50",
        "version": 6
      }
    ],
    "availablePackages": [
      "basic",
      "pro"
    ],
    "usage": 1,
    "capacity": 20,
    "created": 1626259040,
    "modified": 1626259045
  },
  "domains": [
    {
      "name": "example-2021-8-9-14-40-49.com",
      "forward": false,
      "primary": true
    },
    {
      "name": "sub.example-2021-8-9-14-40-49.com",
      "forward": false,
      "primary": false,
      "subDomainOf": "example-2021-8-9-14-40-49.com"
    },
    {
      "name": "sub2.example-2021-8-9-14-40-49.com",
      "forward": true,
      "primary": false,
      "subDomainOf": "example-2021-8-9-14-40-49.com"
    }
  ],
  "suspended": false,
  "renewalDay": 9,
  "period": 1,
  "nextRenewal": "2021-08-10",
  "openJobCount": 1,
  "openJobs": [
    {
      "id": 2,
      "type": "updateHostingPackage",
      "status": "new",
      "created": 1628512942
    }
  ],
  "servicePeriod": 7,
  "serviceStatus": "active",
  "serviceRenewalMonth": 8,
  "nextServiceRenewalDate": "2021-08-16",
  "lastMalwareScan": 1649072362,
  "created": 1628512849,
  "modified": 1628512882,
  "metadata": {
    "smoketest": true
  }
}