URL

get
Get URLs

https://raileo.com/api/v1/urls
Get all the URLs you have created
Request
Response
Request
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Response
200: OK
Cake successfully retrieved.
{
"data": [
{
"id": 2,
"url": "https://example.com",
"url_name": "Example",
"created_at": "2019-09-01 11:45:56"
},
{
"id": 71,
"url": "https://example-two.com",
"url_name": "Example Two",
"created_at": "2019-09-14 09:03:24"
}
]
}
401: Unauthorized
In case of invalid API key or no key
{
"code": 401,
"message": "Invalid API key"
}

get
Get More details about single URL

https://raileo.com/api/v1/urls/1
This will give you more information about uptime, ssl, and pagespeed check for a specific URL
Request
Response
Request
Path Parameters
URL Id
required
number
Id of the URL
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Response
200: OK
{
"data": {
"id": 1,
"url": "https://example.com/",
"url_name": "example Homepage",
"created_at": "2019-09-03 17:43:22",
"latest_uptime_check": [
{
"ping_status": "200",
"last_checked": "2019-12-08 08:00:16",
"is_monitoring_active": 1
}
],
"latest_ssl_check": [
{
"cn": "example.com",
"expires_in": "81",
"id": 8,
"expiry_date": "2020-02-26",
"additional_domains": "[\"example.com\",\"www.example.com\"]",
"last_checked": "2019-12-01 10:20:03",
"is_monitoring_active": 1
}
],
"latest_pagespeed_report": [
{
"device_type": "desktop",
"first_contentful_paint": "0.8 s",
"first_cpu_idle": "1.5 s",
"speed_index": "3.0 s",
"time_to_interact": "1.7 s",
"first_meaningful_paint": "1.0 s",
"accessibility_score": "83",
"pwa_score": "31",
"performance_score": "78",
"best_practices_score": "85",
"seo_score": "90",
"notes": "...",
"created_at": "2019-11-26 17:12:45"
}
]
}
}

post
Create new URL

https://raileo.com/api/v1/urls
Add your URL and setup all monitoring through this endpoint. If the supplied URL is not a secure URL (https://), SSL monitoring will not be enabled. Other monitors will be active.
Request
Response
Request
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Form Data Parameters
name
required
string
Name your URL
url
required
string
Complete URL
Response
200: OK
If supplied URL is not a secure URL, SSL monitoring will not be enabled and you will receive a message like this. "ssl": "SSL setup needs secure URL. SSL monitoring is not enabled"
{
"data": {
"url": "Url Created successfully",
"uptimes": "Uptime Monitoring enabled successfully",
"ssl": "SSL Monitoring enabled successfully",
"pagespeed": "Pagespeed Monitoring enabled successfully"
}
}
422: Unprocessable Entity
Validation Errors
{
"error": {
"message": {
"url": [
"The url field is required."
],
"name": [
"The name field is required."
]
},
"status_code": 422
}
}

delete
Delete URL

https://raileo.com/api/v1/urls/1
Delete a URL. This will delete all other entries such as pagespeed data, uptime data, ssl monitoring data associated with this URL.
Request
Response
Request
Path Parameters
URL ID
required
number
Headers
Authorization
required
string
Bearer 1cvGZuuCSgTjvLBRYart9ikdoM21YFVKfdXotxnH7kuESJki
Response
200: OK
{
"message": "Deleted URL successfully"
}
404: Not Found
{
"error": {
"message": {
"message": "URL Not found"
},
"status_code": 404
}
}