Code Samples #
Copy
curl --request GET \
--url 'https://app.xcloud.host/api/v1/ssl-certificates/{uuid}' \
--header 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://app.xcloud.host/api/v1/ssl-certificates/{uuid}', {
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/ssl-certificates/{uuid}", headers=headers)
print(response.json())
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => 'https://app.xcloud.host/api/v1/ssl-certificates/{uuid}',
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/ssl-certificates/{uuid}");
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/ssl-certificates/{uuid}"))
.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 #
Copy
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"uuid": "5d5a3c5e-3c5e-4a5e-9d5a-3c5e3c5e3c5e",
"provider": "xcloud",
"status": "installed",
"obtained_from": "letsencrypt",
"expires_at": "2026-08-10T00:00:00Z",
"renewal_attempt_at": "2026-05-10T03:00:00Z",
"hostnames": [
"example.com",
"www.example.com"
],
"is_installed": true,
"site": {
"uuid": "11aa22bb-33cc-44dd-55ee-66ff77aa88bb",
"name": "example.com"
},
"created_at": "2025-12-10T00:00:00Z",
"updated_at": "2026-05-10T03: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 details for a single SSL certificate addressed by its own UUID. The raw certificate body and private key are never exposed. Requires the read:sites scope.
Path Parameters #
| Name | Type | Required | Description |
|---|---|---|---|
uuid | string (uuid) | Required | SSL certificate UUID. |
Responses #
200 — SSL certificate #
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Optional | |
message | string | Optional | |
data | object | Optional | |
data | object | Optional | |
data.uuid | string (uuid) | Optional | |
data.provider | string | Optional | Allowed: xcloud, custom, staging, cloudflare, cloudflare_multi_domain |
data.status | string | Optional | Allowed: New, obtained, installed, failed, revoked |
data.obtained_from | string | Optional | Issuing authority where the certificate was obtained (e.g. letsencrypt). |
data.expires_at | string (date-time) | Optional | |
data.renewal_attempt_at | string (date-time) | Optional | Timestamp of the most recent renewal attempt. |
data.hostnames | array of string | Optional | |
data.is_installed | boolean | Optional | True when the certificate is currently installed on the Server. |
data.site | object | Optional | Present on `GET /ssl-certificates/{uuid}` (returns the parent site); omitted from `GET /sites/{uuid}/ssl-certificates` list responses since they are already site-scoped. |
data.site.uuid | string (uuid) | Optional | |
data.site.name | string | Optional | |
data.created_at | string (date-time) | Optional | |
data.updated_at | string (date-time) | Optional |
Example 200 response
Copy
{
"success": true,
"message": "Operation completed successfully.",
"data": {
"uuid": "5d5a3c5e-3c5e-4a5e-9d5a-3c5e3c5e3c5e",
"provider": "xcloud",
"status": "installed",
"obtained_from": "letsencrypt",
"expires_at": "2026-08-10T00:00:00Z",
"renewal_attempt_at": "2026-05-10T03:00:00Z",
"hostnames": [
"example.com",
"www.example.com"
],
"is_installed": true,
"site": {
"uuid": "11aa22bb-33cc-44dd-55ee-66ff77aa88bb",
"name": "example.com"
},
"created_at": "2025-12-10T00:00:00Z",
"updated_at": "2026-05-10T03:00:00Z"
}
}
401 — Missing or invalid authentication token #
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Optional | |
message | string | Optional | |
data | object | Optional |
Example 401 response
Copy
{
"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 |
Example 403 response
Copy
{
"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 #
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Optional | |
message | string | Optional | |
data | object | Optional |
Example 404 response
Copy
{
"success": false,
"message": "Not found.",
"data": null
}
