FOfoudroyer
Health

Run health check for a website

Performs a comprehensive health check on a website including robots.txt, server configuration, and sitemap validation. Returns health issues found.

post/health/check

Request

  • Base URL
    https://api.foudroyer.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Request body

website_idstring required

The ID of the website to check

Example request

{
  "website_id": "website-123"
}

Response

Health check results for the website

idstring required

Unique identifier of the health issue

fk_website_idstring required

The website ID this health issue belongs to

synced_atobject nullable required

Date when the health check was last synced

created_atstring date-time required

Date when the health issue was created

updated_atstring date-time required

Date when the health issue was last updated

Example response

{
  "id": "health-issue-123",
  "fk_website_id": "website-123",
  "robots": [
    {
      "id": "",
      "type": "robots",
      "name": "robots/empty",
      "status": "dont-pass",
      "context": {},
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ],
  "server": [
    {
      "id": "",
      "type": "server",
      "name": "server/not-https",
      "status": "dont-pass",
      "context": {},
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ],
  "sitemap": [],
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.