Loading...

RapidAPI Docs

Uptime check API docs for RapidAPI

Request and response fields for POST /v1/checks/uptime, for developers calling the PingAlert uptime check API through RapidAPI. The RapidAPI console has the current host, headers and request examples.

Already have a PingAlert account? Log in

Endpoint summary

  • 01POST /v1/checks/uptime
  • 02Timeout from 1 to 30 seconds, default 30
  • 03JSON response with status code and response time
  • 04HTTP 504 on timeout, HTTP 429 when rate limited

Quick start

  1. Open the PingAlert listing on RapidAPI and subscribe to a plan.
  2. Copy the current host, headers and your key from the RapidAPI console.
  3. Send POST /v1/checks/uptime with the URL you want to check.
  4. Read isSuccess, statusCode and responseTimeMs from the JSON response.

Calling the endpoint

1. Authentication and plans

RapidAPI manages authentication, the API host and headers, and your plan. Use PingAlert on RapidAPI as the source of truth for request examples and current plan pricing.

2. Keep your key server-side

Treat your RapidAPI key as a backend secret. Call the API from your server, CI job or script, not from browser or mobile client code.

3. Timeouts and rate limits

A check that times out returns HTTP 504 with errorCode TIMEOUT. Requests are rate limited, so handle HTTP 429 by waiting and retrying.

Request and response fields

Request body

  • url (required): the URL to check.
  • type: the monitor type. Multi-step API checks are not supported on this endpoint.
  • timeoutSeconds: 1 to 30, default 30.
  • expectedStatusCode: 100 to 599.
  • expectedKeyword: text to look for in the response.
  • httpMethod (default GET), headers and requestBody.
  • followRedirects and verifySsl.
  • region: optional. A default region is used when omitted.

Response

  • requestId: include this when you contact support.
  • isSuccess and status: the result of the check.
  • statusCode and responseTimeMs.
  • executionDurationMs.
  • region and executedAtUtc: where and when the check ran.
  • errorCode and errorMessage: error details, such as TIMEOUT.

Two ways to use PingAlert

Run on-demand checks through RapidAPI, or monitor around the clock with a PingAlert account.

Subscribe on RapidAPI to call the uptime check API from your own code. Create a PingAlert account when you need continuous monitoring, alerting, incidents, status pages and client workspaces.

PingAlert uptime check API, available on RapidAPI.