Suspend site

Suspend a website on your server.

POST/api/servers/{server}/sites/{id}/suspend

Suspend site

This endpoint suspends a website on your server. You can optionally provide a reason for the suspension.

Optional parameters

Name
reason
Type
string
Description
The reason for suspending the site.

Request

POST

/api/servers/{server}/sites/{id}/suspend

curl -X POST "https://ploi.io/api/servers/{server}/sites/{id}/suspend" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"reason": "You have outstanding invoices, please pay these."}'

Response

{
  "data": {
    "id": 1,
    "status": "suspended",
    "server_id": 1,
    "domain": "suspend.examplehosting.com",
    "test_domain": null,
    "deploy_script": false,
    "web_directory": "/public",
    "project_type": null,
    "project_root": "/",
    "last_deploy_at": null,
    "system_user": "ploi",
    "php_version": "8.0",
    "health_url": null,
    "has_repository": false,
    "zero_downtime_deployment": false,
    "fastcgi_cache": false,
    "created_at": "2021-01-01 00:00:00"
  }
}