OPopenstatus
check

Run a single check

Changed on
post/check/http

Request

  • Base URL
    https://api.openstatus.dev (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header x-openstatus-key

Request body

urlstring required

The url to monitor

bodystring nullable

The body

method'GET' | 'POST' | 'HEAD' | 'PUT' | 'PATCH' | 'DELETE' | 'TRACE' | 'CONNECT' | 'OPTIONS' required
regionsstring[] nullable

Where we should monitor it

runCountnumber

The number of times to run the check

aggregatedboolean

Whether to aggregate the results or not

Example request

{
  "url": "https://www.documenso.co",
  "body": "Hello World",
  "headers": [
    {
      "key": "x-apikey",
      "value": "supersecrettoken"
    }
  ],
  "method": "GET",
  "regions": [
    "ams"
  ]
}

Response

Return a run result

idinteger required

The id of the check

Changes

  • a3ef7e6cc6acRevision changes
    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new SERVICE_UNAVAILABLE enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status