# null
Source: https://docs.hoganhost.com.ng/cloud/cloud-actions



# Getting Started with HoganHost Cloud API

Welcome to the **HoganHost Cloud API**. This guide will help you authenticate, create, manage, and delete your cloud servers programmatically.

All API requests require a **Bearer Token** for authentication.

***

## Authentication

Every request must include your **API Key** in the `Authorization` header:

```bash
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Base URL: https://api.hoganhost.com.ng/v1/
```

* Replace `YOUR_API_KEY` with the key generated in your HoganHost account.
* Without this token, requests will be rejected with an `Unauthorized` error.

***

## Create a Server

Use this endpoint to **provision a new server**. Specify the region, size, and image you want.

```bash
curl -X POST "https://api.hoganhost.com.ng/v1/servers.php" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{
    "name": "my-server",
    "region": "nyc3",
    "size": "s-1vcpu-1gb",
    "image": "ubuntu-22-04-x64"
}'
```

**Response:** Returns JSON with the server ID, IP address, and initial status.

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$url = "https://api.hoganhost.com.ng/v1/servers.php";
    
$data = [
    "name"   => "my-server",
    "region" => "nyc3",
    "size"   => "s-1vcpu-1gb",
    "image"  => "ubuntu-22-04-x64"
];

$ch = curl_init($url);   
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $apiKey",
    "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  
$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

### Example Response

```json
{  
  "id": "12345",
  "name": "my-server",
  "region": "nyc3",
  "size": "s-1vcpu-1gb",
  "image": "ubuntu-22-04-x64",
  "ip_address": "203.0.113.10",
  "status": "provisioning"
}
```

***

## Get Server Information

Retrieve details about an existing server, including IP, region, size, and current status.

```bash
curl -X GET "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID" -H "Authorization: Bearer YOUR_API_KEY"
```

* Replace `SERVER_ID` with the ID returned when the server was created.
* The response will include resource usage, image type, and power state.

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

### Example Response

```json
{
  "id": "12345",
  "name": "my-server",
  "region": "nyc3",
  "size": "s-1vcpu-1gb",
  "image": "ubuntu-22-04-x64",
  "ip_address": "203.0.113.10",
  "status": "active",
  "power_state": "on",
  "created_at": "2025-09-29T10:00:00Z"
}
```

***

## Server Actions

Perform lifecycle operations on a server.\
These actions let you power on/off, reboot, or shut down a server without deleting it.

### Power On

Starts a stopped server.

```bash
curl -X POST "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID&action=actions" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"type":"power_on"}'
```

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId&action=actions";

$data = ["type" => "power_on"];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $apiKey",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

### Power Off

Forcefully powers down the server. Use this if shutdown does not work.

```bash
curl -X POST "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID&action=actions" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"type":"power_off"}'
```

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId&action=actions";

$data = ["type" => "power_off"];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $apiKey",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

### Shutdown

Attempts a graceful shutdown from inside the OS. Safer than `power_off`.

```bash
curl -X POST "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID&action=actions" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"type":"shutdown"}'
```

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId&action=actions";

$data = ["type" => "shutdown"];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $apiKey",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

### Reboot

Restarts the server (like pressing the reset button).

```bash
curl -X POST "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID&action=actions" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d '{"type":"reboot"}'
```

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId&action=actions";

$data = ["type" => "reboot"];

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $apiKey",
  "Content-Type: application/json"
]);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

***

## Delete a Server

Permanently remove a server and all its data.

```bash
curl -X DELETE "https://api.hoganhost.com.ng/v1/servers.php?id=SERVER_ID" -H "Authorization: Bearer YOUR_API_KEY"
```

### Example Request (PHP)

```php
<?php
$apiKey = "YOUR_API_KEY";
$serverId = "SERVER_ID";
$url = "https://api.hoganhost.com.ng/v1/servers.php?id=$serverId";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "Authorization: Bearer $apiKey"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
```

⚠️ **Warning**: This action is irreversible. The server and its data cannot be recovered once deleted.

***

## Best Practices

* Always **shut down** gracefully before running `power_off` or `delete`.
* Use `reboot` for planned updates, not for recovery from major failures.
* Keep track of `SERVER_ID` values returned when creating servers.

***

## Next Steps

* Browse the [API Reference](/api-reference/introduction) for advanced endpoints.
* Automate deployments using your favorite tools (Terraform, Ansible, CI/CD).
* Integrate HoganHost Cloud into your apps for full infrastructure control.


# null
Source: https://docs.hoganhost.com.ng/cloud/introduction



# Cloud hosting Introduction

Welcome to the **HoganHost Cloud API**.\
This guide will walk you through authenticating, provisioning, and managing your servers programmatically.

All API requests are made over **HTTPS** and must include your unique API key.

***

## Authentication

Each request must include your API key in the `Authorization` header:

```bash
curl -X GET "https://cloud.hoganhost.com/api/v1/servers"   -H "Authorization: Bearer YOUR_API_KEY"
```

If your key is missing or invalid, the API responds with an **Unauthorized** error.

***

## Creating a Server

To provision a new server, use the `POST /servers` endpoint:

```bash
curl -X POST "https://api.hoganhost.com.ng/api/v1/servers"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
        "name": "myserver",
        "plan": "s-1vcpu-1gb",
        "region": "nyc1",
        "image": "ubuntu-22-04-x64"
      }'
```

### Field Reference

* **`name`** – A human-friendly identifier for your server. This will also be used as the server’s hostname.\
  Example: `web-01`, `db-primary`.

* **`plan`** – Defines the server’s resources (CPU, RAM, disk).

* **`region`** – The datacenter where your server will be deployed.

* **`image`** – The operating system or application image installed.

***

## Available Plans

| Slug                      | Description                                     |
| ------------------------- | ----------------------------------------------- |
| `s-1vcpu-1gb`             | Standard: 1 vCPU, 1 GB RAM                      |
| `s-1vcpu-2gb`             | Standard: 1 vCPU, 2 GB RAM                      |
| `s-2vcpu-2gb`             | Standard: 2 vCPU, 2 GB RAM                      |
| `s-2vcpu-4gb`             | Standard: 2 vCPU, 4 GB RAM                      |
| `g-2vcpu-8gb`             | General Purpose: 2 vCPU, 8 GB RAM               |
| `g-4vcpu-16gb`            | General Purpose: 4 vCPU, 16 GB RAM              |
| `g-8vcpu-32gb`            | General Purpose: 8 vCPU, 32 GB RAM              |
| `g-16vcpu-64gb`           | General Purpose: 16 vCPU, 64 GB RAM             |
| `c-2`                     | Compute Optimized: 2 vCPU                       |
| `c-4`                     | Compute Optimized: 4 vCPU                       |
| `c-8`                     | Compute Optimized: 8 vCPU                       |
| `c-16`                    | Compute Optimized: 16 vCPU                      |
| `s-1vcpu-1gb-35gb-intel`  | Standard (Intel): 1 vCPU, 1 GB RAM, 35 GB Disk  |
| `s-1vcpu-2gb-70gb-intel`  | Standard (Intel): 1 vCPU, 2 GB RAM, 70 GB Disk  |
| `s-2vcpu-2gb-90gb-intel`  | Standard (Intel): 2 vCPU, 2 GB RAM, 90 GB Disk  |
| `s-2vcpu-4gb-120gb-intel` | Standard (Intel): 2 vCPU, 4 GB RAM, 120 GB Disk |
| `g-2vcpu-8gb-intel`       | General Purpose (Intel): 2 vCPU, 8 GB RAM       |
| `g-4vcpu-16gb-intel`      | General Purpose (Intel): 4 vCPU, 16 GB RAM      |
| `g-8vcpu-32gb-intel`      | General Purpose (Intel): 8 vCPU, 32 GB RAM      |
| `g-16vcpu-64gb-intel`     | General Purpose (Intel): 16 vCPU, 64 GB RAM     |
| `c-4-intel`               | Compute Optimized (Intel): 4 vCPU               |
| `c-8-intel`               | Compute Optimized (Intel): 8 vCPU               |
| `c-16-intel`              | Compute Optimized (Intel): 16 vCPU              |
| `c-32-intel`              | Compute Optimized (Intel): 32 vCPU              |

***

## Available Regions

| Slug   | Location        | Country     |
| ------ | --------------- | ----------- |
| `nyc1` | New York 1      | USA         |
| `nyc3` | New York 3      | USA         |
| `sfo2` | San Francisco 2 | USA         |
| `sfo3` | San Francisco 3 | USA         |
| `ams3` | Amsterdam 3     | Netherlands |
| `sgp1` | Singapore 1     | Singapore   |
| `lon1` | London 1        | UK          |
| `fra1` | Frankfurt 1     | Germany     |
| `tor1` | Toronto 1       | Canada      |
| `blr1` | Bangalore 1     | India       |

***

## Available Images

Below are common base and application images:

| Slug               | Description                  |
| ------------------ | ---------------------------- |
| `ubuntu-24-04-x64` | Ubuntu 24.04 LTS (x64)       |
| `ubuntu-22-04-x64` | Ubuntu 22.04 LTS (x64)       |
| `ubuntu-20-04-x64` | Ubuntu 20.04 LTS (x64)       |
| `debian-12-x64`    | Debian 12 (x64)              |
| `debian-11-x64`    | Debian 11 (x64)              |
| `rockylinux-9-x64` | Rocky Linux 9 (x64)          |
| `rockylinux-8-x64` | Rocky Linux 8 (x64)          |
| `almalinux-8-x64`  | AlmaLinux 8 (x64)            |
| `fedora-40-x64`    | Fedora 40 (x64)              |
| `centos-7-x64`     | CentOS 7 (legacy)            |
| `docker-20-04`     | Docker on Ubuntu 20.04 (x64) |

***

## Best Practices

* Use `shutdown` before `power_off` or `delete` for graceful termination.
* Reserve `reboot` for controlled restarts rather than issue recovery.
* Store and track your `server_id` for later operations.
* Prefer LTS images for long-term stability and security.
* Deploy servers in regions nearest to your end users for optimal latency.


# Introduction
Source: https://docs.hoganhost.com.ng/index

An intro to Hoganhost Documentation.

## Setting up

Our API is designed to empower developers, streamline workflows, and enhance applications by providing seamless access to domains, hosting services, and communication tools. This comprehensive documentation serves as your guide to understanding and leveraging the full capabilities of the HoganHost API.

Inside, you will find detailed explanations, practical examples, and step-by-step instructions to help you integrate our services efficiently. Whether you are an experienced developer or just getting started, our goal is to make your experience with the HoganHost API smooth, productive, and rewarding.

## Current Products with API Access

. Domain Management

. Web Hosting Services

. Communication Tools & Integrations

. And more

<Card title="Start here" icon="rocket" horizontal>
  Follow our three step quickstart guide.
</Card>

<Columns cols={2}>
  <Card title="Domains" icon="pen-to-square" href="/">
    Our Domains API allows you to manage domain registration, renewal, and DNS settings seamlessly.
  </Card>

  <Card title="Cloud Server" icon="palette" href="/cloud/">
    Our Cloud Server API allows you to provision, manage, and scale virtual servers effortlessly, giving you full control over computing resources and infrastructure.
  </Card>

  <Card title="Reseller" icon="map">
    Our Reseller Hosting API enables you to manage client accounts, allocate resources, and automate hosting services for your customers efficiently.
  </Card>

  <Card title="Shared Hosting" icon="terminal">
    Our Shared Hosting API lets you manage shared hosting accounts, control resources, and streamline website deployment with ease.
  </Card>
</Columns>