Sites

Get all sites in your account

GET https://siteguard.app/api/monitors

Headers

Name	Type	Description
Authentication	string	Your API Bearer Token

200

{
  "data": [
    {
      "id": 1,
      "protocol": "https://",
      "url": "example.com",
      "uptime_check_enabled": true,
      "certificate_check_enabled": true,
      "broken_links_check_enabled": true,
      "mixed_content_check_enabled": true,
      "down_since": null,
      "team_id": 1,
      "created_at": "2018-10-13T17:57:05.000000Z",
      "updated_at": "2020-08-10T16:56:11.000000Z",
      "latest_uptime_check_id": 1,
      "latest_certificate_check_id": 2,
      "latest_broken_links_check_id": 3,
      "latest_mixed_content_check_id": 4,
      "latest_downtime_id": null,
      "team": {
        "id": 1,
        "name": "Default"
      }
    },
    {
      "id": 1,
      "protocol": "https://",
      "url": "siteguard.app",
      "uptime_check_enabled": true,
      "certificate_check_enabled": true,
      "broken_links_check_enabled": true,
      "mixed_content_check_enabled": true,
      "down_since": null,
      "team_id": 1,
      "created_at": "2018-10-13T17:57:05.000000Z",
      "updated_at": "2020-08-10T16:56:11.000000Z",
      "latest_uptime_check_id": 1,
      "latest_certificate_check_id": 2,
      "latest_broken_links_check_id": 3,
      "latest_mixed_content_check_id": 4,
      "latest_downtime_id": null,
      "team": {
        "id": 2,
        "name": "SiteGuard"
      }
    }
  ]
}

Get a specific site

GET https://siteguard.app/api/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The id of the site

Headers

Name	Type	Description
Authentication	string	Your API Bearer Token

200

{
  "id": 12,
  "team_id": 1,
  "protocol": "https://",
  "url": "example.com",
  "uptime_check_enabled": true,
  "look_for_string": null,
  "certificate_check_enabled": true,
  "broken_links_check_enabled": true,
  "mixed_content_check_enabled": true,
  "down_since": null,
  "created_at": "2018-10-13T17:57:05.000000Z",
  "updated_at": "2020-08-10T16:56:11.000000Z",
  "latest_uptime_check_id": 657682,
  "latest_certificate_check_id": 358641,
  "latest_broken_links_check_id": 3090,
  "latest_mixed_content_check_id": 4665,
  "latestUptimeCheck": {
    "id": 657682,
    "failure_reason": null,
    "ended_at": "2020-08-17T15:26:12.000000Z",
    "type": "Uptime",
    "type_url": "uptime"
  },
  "latestCertificateCheck": {
    "id": 358641,
    "failure_reason": null,
    "ended_at": "2020-08-17T14:20:17.000000Z",
    "type": "Certificate",
    "type_url": "certificate"
  },
  "latestBrokenLinksCheck": {
    "id": 3090,
    "failure_reason": null,
    "ended_at": "2020-08-17T13:01:04.000000Z",
    "type": "Broken Links",
    "type_url": "broken-links"
  },
  "latestMixedContentCheck": {
    "id": 4665,
    "failure_reason": null,
    "ended_at": "2020-08-17T13:00:29.000000Z",
    "type": "Mixed Content",
    "type_url": "mixed-content"
  },
  "team": {
    "id": 1,
    "name": "Default"
  }
}

Create a new site

POST https://siteguard.app/api/monitors

Headers

Name	Type	Description
Authentication	string	Your API Bearer Token

Request Body

Name	Type	Description
url	string	The full url of the site we should monitor
team_id	string	The id of the team you want to add the site to.

200

{
  "id": 1,
  "team_id": 1,
  "protocol": "https://",
  "url": "example.com",
  "uptime_check_enabled": true,
  "look_for_string": null,
  "certificate_check_enabled": true,
  "broken_links_check_enabled": true,
  "mixed_content_check_enabled": true,
  "down_since": null,
  "created_at": "2018-10-13T17:57:05.000000Z",
  "updated_at": "2020-08-10T16:56:11.000000Z",
  "latest_uptime_check_id": null,
  "latest_certificate_check_id": null,
  "latest_broken_links_check_id": null,
  "latest_mixed_content_check_id": null,
  "latestUptimeCheck": null,
  "latestCertificateCheck": null,
  "latestBrokenLinksCheck": null,
  "latestMixedContentCheck": null,
  "team": {
    "id": 1,
    "name": "Default"
  }
}

Update an existing site

PUT https://siteguard.app/api/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The id of the site

Headers

Name	Type	Description
Authentication	string	Your API Bearer Token

Request Body

Name	Type	Description
look_for_string	string	A string we should check for on the request body
uptime_check_enabled	boolean
certificate_check_enabled	boolean
broken_links_check_enabled	boolean
mixed_content_check_enabled	boolean

200

[]

Delete a site

DELETE https://siteguard.app/api/monitors/{id}

Path Parameters

Name	Type	Description
id	number	The id of the site

200

[]