{
"openapi": "3.0.1",
"info": {
"title": "SiteVerdict — SSL & Uptime Monitor with Status Page",
"description": "Schedule it to check uptime, response time, keywords and SSL/TLS certificate expiry for your URLs, keep history, and publish a hosted static status page (HTML + JSON + uptime badges) with incidents. Alerts on down, recovery and expiring certificates via Slack or webhook.",
"version": "1.1",
"x-build-id": "4jipedbcMNRpzVJ5D"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/siteverdict~siteverdict-ssl-uptime-status-page/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-ssl-uptime-status-page",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/siteverdict~siteverdict-ssl-uptime-status-page/runs": {
"post": {
"operationId": "runs-sync-siteverdict-siteverdict-ssl-uptime-status-page",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/siteverdict~siteverdict-ssl-uptime-status-page/run-sync": {
"post": {
"operationId": "run-sync-siteverdict-siteverdict-ssl-uptime-status-page",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"urls": {
"title": "URLs to monitor",
"type": "array",
"description": "One per line. Optionally name it: Website | https://example.com. https:// is added when missing. Max 200.",
"items": {
"type": "string"
}
},
"monitors": {
"title": "Advanced monitors (JSON)",
"type": "array",
"description": "Optional per-URL settings: [{\"url\":\"https://api.example.com/health\",\"name\":\"API\",\"expectKeyword\":\"ok\",\"keywordMode\":\"present\",\"acceptStatuses\":[200,204],\"showUrl\":false}]"
},
"pageTitle": {
"title": "Status page title",
"type": "string",
"description": "Shown at the top of the published status page.",
"default": "Service status"
},
"publishPage": {
"title": "Publish status page",
"type": "boolean",
"description": "Writes status.html, status.json and one SVG uptime badge per monitor to the state store (public links are in OUTPUT and the dataset).",
"default": true
},
"showUrlsOnPage": {
"title": "Show URLs on the page",
"type": "boolean",
"description": "Turn off to show only the monitor names (e.g. for internal health endpoints).",
"default": true
},
"timeoutSecs": {
"title": "Timeout (seconds)",
"minimum": 3,
"maximum": 60,
"type": "integer",
"description": "Per request.",
"default": 20
},
"slowResponseMs": {
"title": "Slow response threshold (ms)",
"minimum": 200,
"maximum": 60000,
"type": "integer",
"description": "Responses slower than this are marked degraded.",
"default": 3000
},
"tlsWarnDays": {
"title": "Warn when the certificate expires within (days)",
"minimum": 1,
"maximum": 90,
"type": "integer",
"description": "Certificates expiring within this many days mark the check degraded and trigger an alert.",
"default": 14
},
"confirmFailures": {
"title": "Confirm failures with one retry",
"type": "boolean",
"description": "Re-checks after 5 s before declaring a URL down (reduces false alarms from brief blips).",
"default": true
},
"maxConcurrency": {
"title": "Parallel checks",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "How many URLs are checked in parallel (one request per origin per second).",
"default": 5
},
"historySize": {
"title": "Checks kept per monitor",
"minimum": 10,
"maximum": 5000,
"type": "integer",
"description": "History used for uptime % and the status bars (1,000 checks = ~3.5 days at 5-minute intervals, ~10 days at 15 minutes).",
"default": 1000
},
"stateStoreName": {
"title": "State store name",
"type": "string",
"description": "Named key-value store that keeps history and hosts the status page. Use one name per status page.",
"default": "siteverdict-status-page"
},
"alertOn": {
"title": "Alert on",
"type": "array",
"description": "Alerts are sent once per state change (not on every failing check).",
"items": {
"type": "string",
"enum": [
"down",
"recovery",
"tls-expiring",
"tls-untrusted",
"slow"
],
"enumTitles": [
"Went down",
"Recovered",
"Certificate expiring (warn days, 7, 3, 1, expired)",
"Certificate not trusted",
"Slow response (every check)"
]
},
"default": [
"down",
"recovery",
"tls-expiring",
"tls-untrusted"
]
},
"webhookUrl": {
"title": "Webhook URL (https)",
"type": "string",
"description": "We POST a JSON digest of the run's alerts here. Stored encrypted, never logged."
},
"slackWebhookUrl": {
"title": "Slack incoming webhook URL",
"type": "string",
"description": "https://hooks.slack.com/services/... Stored encrypted, never logged."
},
"sampleMode": {
"title": "Sample mode (no network, free)",
"type": "boolean",
"description": "Simulated checks for three fictional example.com monitors with seeded history, so you can see the page, alerts and output. Nothing is charged.",
"default": false
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}