Skip to main content
POST
/
up
Check if a site is up or down
curl --request POST \
  --url https://api.geekflare.com/up \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://example.com",
  "followRedirect": false,
  "proxyCountry": "us"
}
'
{
  "timestamp": 1778737930991,
  "apiStatus": "success",
  "apiCode": 200,
  "message": "Site is up",
  "meta": {
    "url": "example.com",
    "proxyCountry": "US",
    "followRedirect": true,
    "redirectedURL": "https://www.example.com",
    "test": {
      "id": "zmkqoxxu075dwn4u61yoqhq2rwo0029m"
    }
  },
  "data": {
    "statusCode": 200,
    "reasonPhrase": "OK"
  }
}

Authorizations

​
x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
​
url
string
required

Target URL

Example:

"https://example.com"

​
followRedirect
boolean
default:false

Whether to follow redirects when checking site status

Example:

false

​
proxyCountry
string

Proxy country code to route the request

Example:

"us"

Response

Site status retrieved successfully

​
timestamp
number
required

Timestamp of the request in milliseconds

Example:

1778737930991

​
apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

​
apiCode
number
required

API status code

Example:

200

​
message
string
required

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

Example:

"Site is up"

​
meta
object
required

Metadata about the site status check.

Example:
{
  "url": "example.com",
  "proxyCountry": "US",
  "followRedirect": true,
  "redirectedURL": "https://www.example.com",
  "test": { "id": "zmkqoxxu075dwn4u61yoqhq2rwo0029m" }
}
​
data
object
required

HTTP status information from the site check.

Example:
{ "statusCode": 200, "reasonPhrase": "OK" }