v51

OpenAPI 3.0.0raw.githubusercontent.com2026-08-01267339950.6 KB
Agency Hosting: Websites

Get Agency Plan website details

Retrieves detailed information about a specific Agency Plan website, including configuration, status, metadata, hosting plan details, and resource quotas.

get/api/agency-hosting/v1/websites/{website_uid}

Path parameters

website_uidstring required
Example:zpwlGlp19

Agency Plan website UID

Response

Success response

uidstring

Website UID

ipv4string

IPv4 address

flavorstring

Setup flavor

typestring nullable

Website type

descriptionstring nullable

Description

state'active' | 'suspended'

Website state

created_atstring date-time

Example response

{
  "uid": "zpwlGlp19",
  "ipv4": "192.161.10.1",
  "flavor": "wp-6.2.0",
  "type": "node-static",
  "description": "Very awesome website",
  "state": "active",
  "created_at": "2024-05-29T05:49:49+00:00",
  "domains": [
    {
      "fqdn": "test.com",
      "parent_fqdn": "test.com",
      "ipv6": "2001:db8::1",
      "created_at": "2024-05-29T05:49:49+00:00",
      "nameservers": [
        "a.dns-parking.com",
        "b.dns-parking.com"
      ],
      "ssl_cert": {
        "names": [
          "test.com",
          "www.test.com"
        ],
        "expires_at": "2024-05-29T05:49:49+00:00",
        "created_at": "2024-05-29T05:49:49+00:00"
      },
      "custom_ssl_cert": {
        "expires_at": "2024-05-29T05:49:49+00:00",
        "created_at": "2024-05-29T05:49:49+00:00"
      }
    }
  ],
  "preview_domain": {
    "fqdn": "plum-bee-184082.hostingersite.com",
    "created_at": "2024-05-29T05:49:49+00:00"
  },
  "settings": {
    "php": {
      "version": "8.3",
      "workers": 4
    }
  },
  "wordpress": {
    "domain": "test.com",
    "title": "My Blog",
    "language": "en_US",
    "is_config_locked": true,
    "created_at": "2024-05-29T05:49:49+00:00"
  },
  "remote_access": {
    "mode": "ssh_and_sftp",
    "ssh": {
      "username": "u123456789_abcDeFg",
      "host": "192.161.10.1",
      "port": 65002,
      "is_enabled": true,
      "is_password_enabled": true
    },
    "sftp": {
      "username": "u123456789_abcDeFg",
      "host": "192.161.10.1",
      "port": 65002,
      "is_enabled": true
    }
  },
  "server": {
    "hostname": "us-west-1.hstgr.io",
    "country_code": "us"
  },
  "order": {
    "id": 123456,
    "status": "active",
    "created_at": "2024-05-29T05:49:49+00:00",
    "plan": {
      "name": "Hosting Single",
      "parameters": {
        "disk_quota_bytes": 21474836480,
        "inode_quota": 10000,
        "cpu_cores": 2,
        "memory_quota_bytes": 1073741824,
        "disk_iops_quota": 100000,
        "process_quota": 10000,
        "website_quota": 10,
        "max_databases_per_website": 5,
        "is_cdn_available": true
      }
    }
  },
  "user": {
    "username": "u123456789",
    "state": "active"
  },
  "staging_root": {
    "uid": "zpwlGlp19"
  }
}