Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-132176113.0 KB
up

Check if a site is up or down

post/up

Request body

urlstring required

Target URL

proxyCountrystring

Proxy country code to route the request

followRedirectboolean

Whether to follow redirects when checking site status

Example request

{
  "url": "https://example.com",
  "proxyCountry": "us"
}

Response

Site status retrieved successfully

timestampnumber required

Timestamp of the request in milliseconds

apiStatus'success' | 'failure' required

API status message

apiCodenumber required

API status code

messagestring required

Indicates the current status of the site. It can either be "Site is up" or "Unable to reach the URL."

dataobject required

HTTP status information from the site check.

Example response

{
  "timestamp": 1763372588297,
  "apiStatus": "success",
  "apiCode": 200,
  "message": "Site is up",
  "meta": {
    "url": "https://example.com",
    "followRedirect": true,
    "proxyCountry": "US",
    "test": {
      "id": "mxqx9v9y0742lap6altwdteqd28t23nq"
    }
  },
  "data": {
    "statusCode": 200,
    "reasonPhrase": "OK"
  }
}