---
title: Get Domain Update Status
description: "Returns the most recent domain-update status from the site's domainChangeInfo metadata. Read-only — does not trigger a live SSH check. Returns status=idle when no domain update has been recorded. Requires…"
url: "https://betterdocs.shahrear.msf.bd/index.php/docs/hell0-boys-docs/hell0-boys/sites/get-domain-update-status/"
updated: "2026-08-20"
category: hell0 boys / Sites
---

# Get Domain Update Status

GET`/sites/{uuid}/domain/status`

## Code Samples

```curl

                curl --request GET \
  --url 'https://app.xcloud.host/api/v1/sites/{uuid}/domain/status' \
  --header 'Authorization: Bearer YOUR_TOKEN'

                const response = await fetch('https://app.xcloud.host/api/v1/sites/{uuid}/domain/status', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});

const data = await response.json();
console.log(data);

                import requests

headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}

response = requests.get("https://app.xcloud.host/api/v1/sites/{uuid}/domain/status", headers=headers)

print(response.json())

                <?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://app.xcloud.host/api/v1/sites/{uuid}/domain/status',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
  'Authorization: Bearer YOUR_TOKEN'
  ],
]);

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

echo $response;

                using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage(new HttpMethod("GET"), "https://app.xcloud.host/api/v1/sites/{uuid}/domain/status");
request.Headers.Add("Authorization", "Bearer YOUR_TOKEN");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

                import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://app.xcloud.host/api/v1/sites/{uuid}/domain/status"))
    .header("Authorization", "Bearer YOUR_TOKEN")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
```

## Response

```json

                {
    "success": true,
    "message": "Domain update status retrieved successfully.",
    "data": {
        "status": "updating",
        "label": "Updating",
        "is_updating": true,
        "old_domain": "old.example.com",
        "new_domain": "new.example.com",
        "message": null,
        "started_at": "2026-05-17T10:00:00Z"
    }
}

                {
    "success": false,
    "message": "Unauthenticated.",
    "data": null
}

                {
    "success": false,
    "message": "This action is unauthorized. Your token is missing the required scope.",
    "data": null
}

                {
    "success": false,
    "message": "Not found.",
    "data": null
}
```

Returns the most recent domain-update status from the site's `domainChangeInfo` metadata. Read-only — does not trigger a live SSH check. Returns `status=idle` when no domain update has been recorded. Requires the `read:sites` scope.

## Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `uuid` | string (uuid) | **Required** | UUID of the site |

## Responses

### 200 — Domain update status

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |
| `data` | object | Optional |  |
| `data.status` | string | Optional | Current state of the most recent domain change. Allowed: idle, updating, success, failed |
| `data.label` | string | Optional | Human-readable status label. |
| `data.is_updating` | boolean | Optional | True when a domain change is currently in progress. |
| `data.old_domain` | string | Optional |  |
| `data.new_domain` | string | Optional |  |
| `data.message` | string | Optional | Outcome message set when the update completed or failed. |
| `data.started_at` | string (date-time) | Optional |  |

```json

                {
    "success": true,
    "message": "Domain update status retrieved successfully.",
    "data": {
        "status": "updating",
        "label": "Updating",
        "is_updating": true,
        "old_domain": "old.example.com",
        "new_domain": "new.example.com",
        "message": null,
        "started_at": "2026-05-17T10:00:00Z"
    }
}
```

### 401 — Missing or invalid authentication token

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "Unauthenticated.",
    "data": null
}
```

### 403 — Token lacks the required scope

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "This action is unauthorized. Your token is missing the required scope.",
    "data": null
}
```

### 404 — Resource not found or not accessible to your [Team](https://betterdocs.shahrear.msf.bd/encyclopedia/team/)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |

```json

                {
    "success": false,
    "message": "Not found.",
    "data": null
}
```