Robot access

Control search robot access to your site.


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

Update robot access

This endpoint allows you to control whether search robots should be blocked from accessing your site. It's up to the robot to honor this request.

Required parameters

  • Name
    disable_robots
    Type
    boolean
    Description

    Whether the robots should be blocked or not.

Request

PATCH
/api/servers/{server}/sites/{id}
curl -X PATCH "https://ploi.io/api/servers/{server}/sites/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"disable_robots": true}'

Response

{
  "data": {
    "id": 1,
    "status": "active",
    "server_id": 1,
    "domain": "awesome.com",
    "test_domain": null,
    "deploy_script": "cd /home/ploi/awesome.com\ngit pull origin master...",
    "web_directory": "/public",
    "project_type": "laravel",
    "project_root": "/",
    "last_deploy_at": "2021-09-20 08:39:46",
    "system_user": "ploi",
    "php_version": "8.0",
    "health_url": null,
    "disable_robots": true,
    "has_repository": true,
    "zero_downtime_deployment": false,
    "has_staging": false,
    "fastcgi_cache": false,
    "created_at": "2021-01-01 00:00:00"
  }
}