Get a hosting subscription
curl --request GET \
--url https://my.server.express/api/v1/hosting/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/hosting/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/hosting/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"billingStatus": "ACTIVE",
"nextDueDate": "2023-11-07T05:31:56Z",
"price": 123,
"currency": "<string>",
"billingCycle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"status": "<string>",
"username": "<string>",
"location": "<string>",
"plan": {
"name": "<string>",
"diskQuotaMb": 123,
"trafficGb": 123,
"domains": 123,
"mailboxes": 123,
"databases": 123
},
"usage": {
"diskUsedBytes": 123,
"trafficUsedBytes": 123
},
"provisionError": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Hosting
Get a hosting subscription
One subscription with its plan limits and, when the account is ACTIVE and Plesk answers, live disk and traffic usage.
Usage is best-effort: if Plesk is slow or down usage is null and the rest still loads. provisionError explains a
stuck order. Readable by the owner and any team member.
GET
/
v1
/
hosting
/
{id}
Get a hosting subscription
curl --request GET \
--url https://my.server.express/api/v1/hosting/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://my.server.express/api/v1/hosting/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://my.server.express/api/v1/hosting/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"billingStatus": "ACTIVE",
"nextDueDate": "2023-11-07T05:31:56Z",
"price": 123,
"currency": "<string>",
"billingCycle": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"status": "<string>",
"username": "<string>",
"location": "<string>",
"plan": {
"name": "<string>",
"diskQuotaMb": 123,
"trafficGb": 123,
"domains": 123,
"mailboxes": 123,
"databases": 123
},
"usage": {
"diskUsedBytes": 123,
"trafficUsedBytes": 123
},
"provisionError": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
bearerAuthapiToken
Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh. A session satisfies every API scope.
Path Parameters
The hosting service id.