OPopenstatus
monitor

Get a monitor

Changed on
get/monitor/{id}

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

Path parameters

idstring required

The id of the monitor

Example:1

Response

The monitor

idnumber required

The id of the monitor

periodicity'30s' | '1m' | '5m' | '10m' | '30m' | '1h' | 'other' required

How often the monitor should run

urlstring required

The url to monitor

regionsstring[] nullable

Where we should monitor it

namestring required

The name of the monitor

externalNamestring nullable

The external name of the monitor, used to display on the status page or in the external notifications

descriptionstring nullable

The description of your monitor

method'GET' | 'POST' | 'HEAD' | 'PUT' | 'PATCH' | 'DELETE' | 'TRACE' | 'CONNECT' | 'OPTIONS' required
bodystring nullable

The body

activeboolean

If the monitor is active

publicboolean

If the monitor is public

degradedAfternumber nullable

The time after the monitor is considered degraded in milliseconds

timeoutnumber nullable

The timeout of the request in milliseconds

retrynumber

The number of retries to attempt

followRedirectsboolean

If the monitor should follow redirects

jobType'http' | 'tcp' | 'icmp' | 'grpc' | 'udp' | 'dns' | 'ssl'

The type of the monitor

Example response

{
  "id": 123,
  "periodicity": "1m",
  "url": "https://www.documenso.co",
  "regions": [
    "ams"
  ],
  "name": "documenso-web",
  "externalName": "Documenso",
  "description": "Documenso website",
  "method": "GET",
  "body": "Hello World",
  "headers": [
    {
      "key": "x-apikey",
      "value": "supersecrettoken"
    }
  ]
}

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

    • warning

      added the new grpc 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