Website Monitoring API

Real Website Monitoring API

PageOK offers a website monitoring API that lives up to its name. With our API you can do more than just manage your account - you have access to all functions and tests. This means you get the best real website monitoring API to integrate our capabilities into your systems.

API Endpoint

The general endpoint for our API is:

https://api.pageok.net/api

API Key

You can generate and manage your API Key in your Account > API Key area.

Authorization

Our Monitoring APIs using HTTP Basic Authentication via HTTPS. To authenticate use the API-Key as username. The password can be set to anything. In our example the password is 'x'. Username/API-Key and password need to be base64 encoded.

base64encode(api-key:password)

We recommend to use https://www.base64encode.org to encode your authentication string.

Example:

API-Key: abcd12efgh34
Password: x
String to encode: abcd12efgh34:x
Base64encoded: YWJjZDEyZWZnaDM0Ong=

Send the encoded string like the following header.

Authorization: Basic base64encode(api-key:password)

General options

Output

JSON (default)
XML
HTML

Example:

https://api.pageok.net/api/uptime/111?format=xml

HTTP Response Codes

200 OK
401 Authorization failed
422 Wrong parameters
429 Too many attempts

Status

Endpoint	/status
Method	GET
Parameter
Response	"OK": "domain": integer "page": integer "WARN": "domain": integer "page": integer "CRIT": "domain": integer "page": integer
Example	https://api.pageok.net/api/status

Uptime

Endpoint	/uptime/{page_id}
Method	GET
Parameter	{page_id}
Response	"page_id": integer "url": string "1": float (0.000 - 100.000) "7": float (0.000 - 100.000) "30": float (0.000 - 100.000)
Example	https://api.pageok.net/api/uptime/111

Tests

DNS

Endpoint	/test/dns
Method	GET
Parameter	url={url}
Response	"status": string "time": float "records": array
Example	https://api.pageok.net/api/test/dns?url=www.example.com

Ports

Endpoint	/test/ports
Method	GET
Parameter	url={url}
Response	"results": "80/tcp": "status": string "name": string "443/tcp": "status": string "name": string "status": string
Example	https://api.pageok.net/api/test/ports?url=www.example.com

HTTP

Endpoint	/test/http
Method	GET
Parameter	url={url}
Response	"responsetime": float "status": string "protocol": string "httpcode": integer
Example	https://api.pageok.net/api/test/http?url=www.example.com

SSL

Endpoint	/test/ssl
Method	GET
Parameter	url={url}
Response	"status": text "expiredays": integer
Example	https://api.pageok.net/api/test/ssl?url=www.example.com

SEO

Endpoint	/test/seo
Method	GET
Parameter	{page_id}
Response	"sitemap": "url": string "domain": string "path": string "status": string "httpcode": string "robots": "status": string "httpcode": string
Example	https://api.pageok.net/api/test/seo?url=www.example.com

Account

Endpoint	/account
Method	GET
Parameter
Response	"userID": integer "email": string "fullname": string "phonenumber": string "language_id": string "package": string "subscription": "status": string
Example	https://api.pageok.net/api/account