---
title: Get SSH Restriction Status
description: "Returns whether xCloud infrastructure IPs are whitelisted and whether the API caller's IP is whitelisted on the server's SSH firewall. Use before any rule-tightening operation to check for lockout risk.…"
url: "https://betterdocs.shahrear.msf.bd/index.php/docs/hell0-boys-docs/hell0-boys/servers/get-ssh-restriction-status/"
updated: "2026-08-20"
category: hell0 boys / Servers
---

# Get SSH Restriction Status

GET`/servers/{uuid}/firewall/ssh-restriction-status`

## Code Samples

```curl

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

                const response = await fetch('https://app.xcloud.host/api/v1/servers/{uuid}/firewall/ssh-restriction-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/servers/{uuid}/firewall/ssh-restriction-status", headers=headers)

print(response.json())

                <?php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://app.xcloud.host/api/v1/servers/{uuid}/firewall/ssh-restriction-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/servers/{uuid}/firewall/ssh-restriction-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/servers/{uuid}/firewall/ssh-restriction-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": "Operation completed successfully.",
    "data": {
        "caller_ip": "203.0.113.42",
        "caller_ip_whitelisted": false,
        "xcloud_ips_status": {
            "all_whitelisted": false,
            "missing_ips": [
                "1.2.3.4",
                "5.6.7.8"
            ],
            "not_configured": false
        },
        "jumpbox_ip": "1.2.3.4"
    }
}

                {
    "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 whether xCloud infrastructure IPs are whitelisted and whether the [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) caller's IP is whitelisted on the [Server](https://betterdocs.shahrear.msf.bd/encyclopedia/server/)'s SSH firewall. Use before any rule-tightening operation to check for lockout risk. Requires the `read:servers` scope.

## Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `uuid` | string (uuid) | **Required** | UUID of the [Server](https://betterdocs.shahrear.msf.bd/encyclopedia/server/) |

## Responses

### 200 — SSH restriction status

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | boolean | Optional |  |
| `message` | string | Optional |  |
| `data` | object | Optional |  |
| `data` | object | Optional |  |
| `data.caller_ip` | string | Optional | The IP [Address](https://betterdocs.shahrear.msf.bd/encyclopedia/address/) the [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/) request came from. |
| `data.caller_ip_whitelisted` | boolean | Optional | True when the caller IP is already whitelisted on this [Server](https://betterdocs.shahrear.msf.bd/encyclopedia/server/)'s SSH firewall. |
| `data.xcloud_ips_status` | object | Optional | Whitelist status for xCloud infrastructure IPs (jumpbox, [API](https://betterdocs.shahrear.msf.bd/encyclopedia/api/), backup, monitoring). |
| `data.xcloud_ips_status.all_whitelisted` | boolean | Optional |  |
| `data.xcloud_ips_status.missing_ips` | array of string | Optional |  |
| `data.xcloud_ips_status.not_configured` | boolean | Optional | True when no xCloud SSH-allowed IPs are configured in the environment. |
| `data.jumpbox_ip` | string | Optional | The xCloud jumpbox IP, if configured. |

```json

                {
    "success": true,
    "message": "Operation completed successfully.",
    "data": {
        "caller_ip": "203.0.113.42",
        "caller_ip_whitelisted": false,
        "xcloud_ips_status": {
            "all_whitelisted": false,
            "missing_ips": [
                "1.2.3.4",
                "5.6.7.8"
            ],
            "not_configured": false
        },
        "jumpbox_ip": "1.2.3.4"
    }
}
```

### 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
}
```