{ "openapi": "3.1.0", "info": { "title": "Uptimeify REST API", "version": "1.0.0", "description": "Public REST API for Uptimeify website, DNS, TLS and email monitoring. Authenticate with a Bearer API token (Authorization: Bearer wsm_...). Human docs: https://docs.uptimeify.io/api. Generated from the live route handlers, the docs-site and the maintained API collection.", "contact": { "name": "Uptimeify", "url": "https://uptimeify.io" } }, "servers": [ { "url": "https://uptimeify.io" } ], "tags": [ { "name": "Agent Claim" }, { "name": "Auth" }, { "name": "Change Requests" }, { "name": "Custom Fields" }, { "name": "Customer" }, { "name": "Customer Domains" }, { "name": "Customer Ips" }, { "name": "Customers" }, { "name": "Dns Monitors" }, { "name": "Domains" }, { "name": "Escalation Config" }, { "name": "Ftp Monitors" }, { "name": "Health" }, { "name": "Icmp Monitors" }, { "name": "Imap Pop Monitors" }, { "name": "Incidents" }, { "name": "Maintenance Windows" }, { "name": "Mollie" }, { "name": "Monitor Tags" }, { "name": "Monitoring Locations" }, { "name": "Monitors" }, { "name": "Notification Channels" }, { "name": "Oauth" }, { "name": "Organization" }, { "name": "Organizations" }, { "name": "Package Configs" }, { "name": "Public" }, { "name": "Smtp Monitors" }, { "name": "Ssh Monitors" }, { "name": "Status Pages" }, { "name": "Tags" }, { "name": "Tcp Monitors" }, { "name": "Users" }, { "name": "Websites" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Uptimeify API token, e.g. \"Authorization: Bearer wsm_...\"." } }, "schemas": { "Error": { "type": "object", "description": "Error envelope returned for every non-2xx response. `statusMessage` carries the human-readable reason; where a machine-readable reason exists it is in `data.code`.", "properties": { "error": { "type": "boolean", "const": true, "description": "Always true on an error response." }, "url": { "type": "string", "description": "The request URL that failed." }, "statusCode": { "type": "integer", "description": "HTTP status code, repeated in the body." }, "statusMessage": { "type": "string", "description": "Short reason, safe to show to a user." }, "message": { "type": "string", "description": "Same as statusMessage; kept for client compatibility." }, "data": { "type": "object", "description": "Present on some errors. Carries a stable `code` and, for rate limits, `retryAfter`.", "properties": { "code": { "type": "string", "description": "Stable machine-readable error code." }, "retryAfter": { "type": "integer", "description": "Seconds to wait before retrying (429 only)." } } } }, "required": [ "error", "statusCode", "statusMessage", "message" ] } } }, "paths": { "/api/agent-claim/confirm": { "post": { "operationId": "postApiAgentClaimConfirm", "summary": "POST /api/agent-claim/confirm", "tags": [ "Agent Claim" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/agent-claim/context": { "get": { "operationId": "getApiAgentClaimContext", "summary": "GET /api/agent-claim/context", "tags": [ "Agent Claim" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/auth/get-session": { "get": { "operationId": "getApiAuthGetSession", "summary": "Get Current User", "tags": [ "Auth" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "session": { "userId": "redacted-user", "expiresAt": "2027-04-03T10:05:01.625Z", "token": "" }, "user": { "id": "api-token-redacted", "name": "Name 003", "firstName": "FirstName 004", "lastName": "LastName 005", "organizationId": 1, "isActive": true, "createdAt": "2026-04-03T09:57:48.043Z", "updatedAt": "2026-04-03T09:57:48.043Z", "organizationStatus": "active" } } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/auth/get-session" } }, "/api/change-requests": { "get": { "operationId": "getApiChangeRequests", "summary": "GET /api/change-requests", "tags": [ "Change Requests" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/change-requests/{id}": { "patch": { "operationId": "patchApiChangeRequestsId", "summary": "PATCH /api/change-requests/{id}", "tags": [ "Change Requests" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/custom-fields": { "get": { "operationId": "getApiCustomFields", "summary": "List Custom Fields", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/custom-fields" }, "post": { "operationId": "postApiCustomFields", "summary": "Create Custom Field", "tags": [ "Custom Fields" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/custom-fields", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "organizationId": 1, "name": "Region", "fieldKey": "region", "fieldType": "select", "isRequired": false, "displayOrder": 1, "options": [ "EU", "US", "APAC" ], "placeholder": "Select region", "helpText": "Geographic region", "showInTable": true } } } } } }, "/api/custom-fields/{id}": { "delete": { "operationId": "deleteApiCustomFieldsId", "summary": "Delete Custom Field", "tags": [ "Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/custom-fields/:id" }, "patch": { "operationId": "patchApiCustomFieldsId", "summary": "Update Custom Field", "tags": [ "Custom Fields" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/custom-fields/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Region Updated", "fieldType": "select", "isRequired": false, "displayOrder": 1, "options": [ "EU", "US", "APAC", "LATAM" ], "placeholder": "Select region", "helpText": "Geographic region", "showInTable": true, "isActive": true } } } } } }, "/api/customer-domains": { "get": { "operationId": "getApiCustomerDomains", "summary": "List Customer Domains (Org)", "tags": [ "Customer Domains" ], "parameters": [ { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [], "total": 1, "page": 2, "perPage": 2 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customer-domains" } }, "/api/customer-domains/{id}": { "delete": { "operationId": "deleteApiCustomerDomainsId", "summary": "Delete Customer Domain", "tags": [ "Customer Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/customer-domains/:id" }, "get": { "operationId": "getApiCustomerDomainsId", "summary": "Get Customer Domain", "tags": [ "Customer Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000068", "customerId": 1, "label": "Label 038", "domainName": "uptimeify.io", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7, "createdAt": "2026-04-01T20:55:20.704Z", "updatedAt": "2026-04-01T20:55:20.704Z", "expiry": { "domainExpiresAt": null, "domainRegistrar": null, "isExpired": false, "lastError": null, "lastCheckedAt": null, "lastChangedAt": null, "lastNotifiedWarningAt": null, "lastNotifiedErrorAt": null, "lastNotifiedExpiredAt": null } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customer-domains/:id" }, "patch": { "operationId": "patchApiCustomerDomainsId", "summary": "Update Customer Domain", "tags": [ "Customer Domains" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000068", "customerId": 1, "label": "Label 038", "domainName": "uptimeify.io", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7, "notificationPhoneNumber": null, "notificationEmail": null, "createdAt": "2026-04-01T20:55:20.704Z", "updatedAt": "2026-04-01T20:57:04.313Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/customer-domains/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "active" } } } } } }, "/api/customer-ips": { "get": { "operationId": "getApiCustomerIps", "summary": "List Customer IPs (Org)", "tags": [ "Customer Ips" ], "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [], "total": 1, "page": 4, "perPage": 4 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customer-ips" } }, "/api/customer-ips/{id}": { "delete": { "operationId": "deleteApiCustomerIpsId", "summary": "Delete Customer IP", "tags": [ "Customer Ips" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/customer-ips/:id" }, "get": { "operationId": "getApiCustomerIpsId", "summary": "Get Customer IP", "tags": [ "Customer Ips" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000005c", "customerId": 1, "label": "Label 033", "ipAddress": "203.0.113.16", "ipFamily": "v4", "status": "active", "createdAt": "2026-04-01T20:46:57.134Z", "updatedAt": "2026-04-01T20:46:57.134Z", "dnsbl": { "isListed": true, "listedCount": 2, "listings": [ { "name": "Name 034", "reason": "PBL - ISP Policy", "listKey": "zen.dq.spamhaus.net", "delistUrl": "https://uptimeify.io/", "resultCode": "203.0.113.13" }, { "name": "Name 035", "reason": "Listed in Bogons", "listKey": "bogons.cymru.com", "delistUrl": "https://uptimeify.io/bogon-reference.html", "resultCode": "203.0.113.17" } ], "lastError": null, "lastCheckedAt": "2026-04-01T20:47:00.045Z", "lastChangedAt": "2026-04-01T20:47:00.045Z", "lastListedAt": "2026-04-01T20:47:00.045Z", "lastCleanAt": null, "lastNotifiedListedAt": "2026-04-01T20:47:25.350Z", "lastNotifiedCleanAt": null } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customer-ips/:id" }, "patch": { "operationId": "patchApiCustomerIpsId", "summary": "Update Customer IP", "tags": [ "Customer Ips" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000064", "customerId": 1, "label": "Label 036", "ipAddress": "203.0.113.18", "ipFamily": "v4", "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "createdAt": "2026-02-03T15:06:46.469Z", "updatedAt": "2026-04-03T15:23:15.284Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/customer-ips/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "label": "Label 036", "status": "active" } } } } } }, "/api/customer/tokens": { "get": { "operationId": "getApiCustomerTokens", "summary": "List Customer Tokens", "tags": [ "Customer" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customer/tokens" }, "post": { "operationId": "postApiCustomerTokens", "summary": "Create Customer Token", "tags": [ "Customer" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/customer/tokens", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "My API Token", "expiresInDays": 365, "customerId": null } } } } } }, "/api/customer/tokens/{id}": { "delete": { "operationId": "deleteApiCustomerTokensId", "summary": "Delete Customer Token", "tags": [ "Customer" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/customer/tokens/:id" } }, "/api/customers": { "get": { "operationId": "getApiCustomers", "summary": "List Customers", "tags": [ "Customers" ], "parameters": [ { "name": "Response", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" }, "example": [ { "id": 3, "publicId": "00000000-0000-4000-8000-000000000021", "organizationId": 4, "name": "Name 023", "email": "user004@example.test", "customFields": { "region": "EU", "planOwner": "Operations" }, "packageId": 5, "packageType": "business", "status": "active", "cancellationDate": null, "cancelledAt": null, "notificationEmail": null, "createdAt": "2026-03-31T17:33:51.979Z", "packageConfig": { "displayName": null }, "packageDisplayName": null }, { "id": 6, "publicId": "00000000-0000-4000-8000-000000000023", "organizationId": 4, "name": "Name 027", "email": "user004@example.test", "customFields": {}, "packageId": 7, "packageType": "fullservice", "status": "active", "cancellationDate": null, "cancelledAt": null, "notificationEmail": null, "createdAt": "2026-03-18T07:57:21.664Z", "packageConfig": { "displayName": null }, "packageDisplayName": null } ] } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers" }, "post": { "operationId": "postApiCustomers", "summary": "Create Customer", "tags": [ "Customers" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "customer": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000001d", "organizationId": 1, "name": "Name 023", "email": "user002@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 1, "packageType": "test", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "customFields": { "region": "EU", "planOwner": "Operations" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-04-04T12:40:16.997Z", "updatedAt": "2026-04-04T12:40:16.997Z" } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/customers", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Name 023", "email": "user002@example.test", "packageType": "test", "status": "active", "customFields": { "region": "EU", "planOwner": "Operations" } } } } } } }, "/api/customers/sms-usage": { "get": { "operationId": "getApiCustomersSmsUsage", "summary": "GET /api/customers/sms-usage", "tags": [ "Customers" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/customers/{id}": { "delete": { "operationId": "deleteApiCustomersId", "summary": "Delete Customer", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/customers/:customerPublicId" }, "get": { "operationId": "getApiCustomersId", "summary": "Get Customer Details", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000001d", "organizationId": 1, "name": "Name 023", "email": "user002@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 1, "packageDisplayName": "Name 026", "status": "active", "customFields": { "region": "EU", "planOwner": "Operations" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-04-04T12:40:16.997Z", "updatedAt": "2026-04-04T12:40:16.997Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers/:customerPublicId" }, "patch": { "operationId": "patchApiCustomersId", "summary": "Change Package", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 3, "publicId": "00000000-0000-4000-8000-000000000021", "organizationId": 4, "name": "Name 025", "email": "user004@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 5, "packageType": "business", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "companyName": null, "street": null, "postalCode": null, "city": null, "country": null, "vatId": null, "mollieCustomerId": null, "mollieSubscriptionId": null, "customPricing": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "customFields": { "region": "EU", "planOwner": "Operations" }, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-03-31T17:33:51.979Z", "updatedAt": "2026-03-31T17:34:53.606Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/customers/:customerPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "packageType": "business" } } } } } }, "/api/customers/{id}/domains": { "post": { "operationId": "postApiCustomersIdDomains", "summary": "Create Customer Domain (Customer)", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000068", "customerId": 1, "label": "Label 038", "domainName": "uptimeify.io", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7, "notificationPhoneNumber": null, "notificationEmail": null, "createdAt": "2026-04-01T20:55:20.704Z", "updatedAt": "2026-04-01T20:55:20.704Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/customers/:customerId/domains", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "domainName": "uptimeify.io", "label": "Label 038", "status": "active", "expiryWarningDays": 30, "expiryErrorDays": 7 } } } } } }, "/api/customers/{id}/ips": { "get": { "operationId": "getApiCustomersIdIps", "summary": "List Customer IPs (Customer)", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" }, "example": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000005c", "customerId": 1, "label": "Label 033", "ipAddress": "203.0.113.16", "ipFamily": "v4", "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "createdAt": "2026-04-01T20:46:57.134Z", "updatedAt": "2026-04-01T20:46:57.134Z", "dnsbl": { "isListed": true, "listedCount": 2, "listings": [ { "name": "Name 034", "reason": "PBL - ISP Policy", "listKey": "zen.dq.spamhaus.net", "delistUrl": "https://uptimeify.io/", "resultCode": "203.0.113.13" }, { "name": "Name 035", "reason": "Listed in Bogons", "listKey": "bogons.cymru.com", "delistUrl": "https://uptimeify.io/bogon-reference.html", "resultCode": "203.0.113.17" } ], "lastError": null, "lastCheckedAt": "2026-04-01T20:47:00.045Z", "lastChangedAt": "2026-04-01T20:47:00.045Z", "lastListedAt": "2026-04-01T20:47:00.045Z", "lastCleanAt": null } } ] } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers/:customerId/ips" }, "post": { "operationId": "postApiCustomersIdIps", "summary": "Create Customer IP (Customer)", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000005c", "customerId": 1, "label": "Label 033", "ipAddress": "203.0.113.16", "ipFamily": "v4", "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "createdAt": "2026-04-01T20:46:57.134Z", "updatedAt": "2026-04-01T20:46:57.134Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/customers/:customerId/ips", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "ipAddress": "203.0.113.16", "label": "Label 033", "status": "active" } } } } } }, "/api/customers/{id}/monitor-stats": { "get": { "operationId": "getApiCustomersIdMonitorStats", "summary": "Get Customer Monitor Stats", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers/:customerPublicId/monitor-stats" } }, "/api/customers/{id}/users": { "get": { "operationId": "getApiCustomersIdUsers", "summary": "Get Customer Users", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers/:customerPublicId/users" } }, "/api/customers/{id}/websites": { "get": { "operationId": "getApiCustomersIdWebsites", "summary": "Get Customer Websites", "tags": [ "Customers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/customers/:customerPublicId/websites" } }, "/api/dns-monitors": { "get": { "operationId": "getApiDnsMonitors", "summary": "List DNS Monitors", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000004c", "organizationId": 1, "customerId": 1, "name": "Name 031", "hostname": "uptimeify.io", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": {}, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:45:07.436Z", "createdAt": "2026-04-01T20:45:07.367Z", "updatedAt": "2026-04-01T20:45:07.731Z" } ], "total": 1, "page": 1, "perPage": 50 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/dns-monitors" }, "post": { "operationId": "postApiDnsMonitors", "summary": "Create DNS Monitor", "tags": [ "Dns Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000048", "organizationId": 1, "customerId": 1, "name": "Name 031", "hostname": "uptimeify.io", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": [ "A", "AAAA" ], "matchMode": "exact", "triggerOn": { "mismatch": true, "resolveError": true }, "expectedValues": { "A": [ "203.0.113.14" ], "AAAA": [ "2606:4700:3032::ac43:ad2f" ] }, "requireExpectedValues": false }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-03T15:03:29.941Z", "updatedAt": "2026-04-03T15:03:29.920Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/dns-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 031", "hostname": "uptimeify.io", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": [ "A", "AAAA" ], "matchMode": "exact", "expectedValues": { "A": [ "203.0.113.14" ], "AAAA": [ "2606:4700:3032::ac43:ad2f" ] }, "triggerOn": { "resolveError": true, "mismatch": true } } } } } } } }, "/api/dns-monitors/status/batch": { "post": { "operationId": "postApiDnsMonitorsStatusBatch", "summary": "DNS Monitor Status (Batch)", "tags": [ "Dns Monitors" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/dns-monitors/status/batch" } }, "/api/dns-monitors/{id}": { "delete": { "operationId": "deleteApiDnsMonitorsId", "summary": "Delete DNS Monitor", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/dns-monitors/:dnsMonitorPublicId" }, "get": { "operationId": "getApiDnsMonitorsId", "summary": "Get DNS Monitor", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/dns-monitors/:dnsMonitorPublicId" }, "patch": { "operationId": "patchApiDnsMonitorsId", "summary": "Update DNS Monitor", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000056", "organizationId": 1, "customerId": 1, "name": "Name 031", "hostname": "uptimeify.io", "checkInterval": 30, "timeoutSeconds": 30, "dnsConfig": { "rrtypes": [ "A" ], "matchMode": "exact", "triggerOn": { "mismatch": true, "resolveError": true }, "expectedValues": { "A": [ "203.0.113.14" ] }, "requireExpectedValues": false }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-03T15:13:16.141Z", "createdAt": "2026-04-03T14:54:56.383Z", "updatedAt": "2026-04-03T15:16:20.869Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/dns-monitors/:dnsMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "dnsConfig": { "rrtypes": [ "A" ], "matchMode": "exact", "expectedValues": { "A": [ "203.0.113.14" ] }, "triggerOn": { "resolveError": true, "mismatch": true } } } } } } } }, "/api/dns-monitors/{id}/alert-history": { "get": { "operationId": "getApiDnsMonitorsIdAlertHistory", "summary": "Get DNS Alert History", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/dns-monitors/:dnsMonitorPublicId/alert-history" } }, "/api/dns-monitors/{id}/check-history": { "get": { "operationId": "getApiDnsMonitorsIdCheckHistory", "summary": "Get DNS Monitor Check History", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-000000000050", "status": "success", "errorMessage": null, "warningMessage": null, "timingDns": 48, "diagnostics": { "results": { "A": [ "203.0.113.15" ] }, "rrtypes": [ "A" ], "hostname": "uptimeify.io", "matchMode": "exact", "triggerOn": { "mismatch": true, "resolveError": true }, "dnsMonitorId": 4, "expectedValues": {} }, "checkedAt": "2026-04-01T20:45:07.436Z", "locationId": 9, "locationName": "Name 029", "locationCode": "pl-waw" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/dns-monitors/:dnsMonitorPublicId/check-history" } }, "/api/dns-monitors/{id}/incident-history": { "get": { "operationId": "getApiDnsMonitorsIdIncidentHistory", "summary": "Get DNS Incident History", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/dns-monitors/:dnsMonitorPublicId/incident-history" } }, "/api/dns-monitors/{id}/trigger-check": { "post": { "operationId": "postApiDnsMonitorsIdTriggerCheck", "summary": "Trigger DNS Check", "tags": [ "Dns Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "dnsMonitorId": 4, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "dns-monitor-checks-ch-zrh", "dns-monitor-checks-cz-prg", "dns-monitor-checks-de-fsn", "dns-monitor-checks-de-nbg", "dns-monitor-checks-fi-hel", "dns-monitor-checks-it-mil", "dns-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/dns-monitors/:dnsMonitorPublicId/trigger-check" } }, "/api/domains": { "get": { "operationId": "getApiDomains", "summary": "List Domain Expiry (Websites)", "tags": [ "Domains" ], "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 11, "name": "Name 030", "url": "https://uptimeify.io/", "status": "active", "customerId": 6, "customerName": "Name 027", "checkDomainExpiryEnabled": true, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "domainExpiresAt": null, "domainRegistrar": null, "lastDomainCheckAt": null, "daysUntilExpiry": null, "expiryStatus": "unknown" } ], "total": 1, "page": 1, "perPage": 50 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/domains" } }, "/api/escalation-config/{id}": { "get": { "operationId": "getApiEscalationConfigId", "summary": "Get Escalation Config", "tags": [ "Escalation Config" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/escalation-config/:id" }, "patch": { "operationId": "patchApiEscalationConfigId", "summary": "Update Escalation Config", "tags": [ "Escalation Config" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/escalation-config/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": {}, "webhookBodyTemplate": null, "webhookTimeout": 5000, "webhookRetryAttempts": 3, "webhookRetryDelay": 1000, "expectedStatusCodes": "200,201,202", "isActive": true, "defaultEmail": "escalations@example.com", "defaultPhoneNumber": null } } } } } }, "/api/escalation-config/{id}/test": { "post": { "operationId": "postApiEscalationConfigIdTest", "summary": "Test Escalation Config", "tags": [ "Escalation Config" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/escalation-config/:id/test", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "type": "webhook", "config": {}, "webhookUrl": "https://example.com/webhook", "webhookMethod": "POST", "webhookHeaders": {}, "webhookBodyTemplate": null, "webhookTimeout": 5000, "expectedStatusCodes": "200,201,202" } } } } } }, "/api/ftp-monitors": { "get": { "operationId": "getApiFtpMonitors", "summary": "List FTP Monitors", "tags": [ "Ftp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000006c", "organizationId": 1, "customerId": 1, "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "checkInterval": 5, "timeoutSeconds": 30, "config": { "user": "ftp-user", "secure": "explicit", "password": null }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:58:48.188Z", "createdAt": "2026-04-01T20:58:48.039Z", "updatedAt": "2026-04-01T20:58:48.038Z", "ftpConfig": { "user": "ftp-user", "secure": "explicit", "password": null }, "hasPassword": true } ], "total": 1, "page": 1, "perPage": 50 } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ftp-monitors" }, "post": { "operationId": "postApiFtpMonitors", "summary": "Create FTP Monitor", "tags": [ "Ftp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000006c", "organizationId": 1, "customerId": 1, "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "checkInterval": 5, "timeoutSeconds": 30, "config": { "user": "ftp-user", "secure": "explicit", "password": null }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T20:58:48.039Z", "updatedAt": "2026-04-01T20:58:48.038Z", "ftpConfig": { "user": "ftp-user", "secure": "explicit", "password": null }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/ftp-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "status": "active", "checkInterval": 5, "timeoutSeconds": 30, "ftpConfig": { "user": "ftp-user", "password": "redacted-secret", "secure": "explicit" } } } } } } }, "/api/ftp-monitors/{id}": { "delete": { "operationId": "deleteApiFtpMonitorsId", "summary": "Delete FTP Monitor", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/ftp-monitors/:ftpMonitorPublicId" }, "get": { "operationId": "getApiFtpMonitorsId", "summary": "Get FTP Monitor", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000006c", "organizationId": 1, "customerId": 1, "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "checkInterval": 5, "timeoutSeconds": 30, "config": { "user": "ftp-user", "secure": "explicit", "password": null }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:58:48.188Z", "createdAt": "2026-04-01T20:58:48.039Z", "updatedAt": "2026-04-01T20:58:48.038Z", "ftpConfig": { "user": "ftp-user", "secure": "explicit", "password": null }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ftp-monitors/:ftpMonitorPublicId" }, "patch": { "operationId": "patchApiFtpMonitorsId", "summary": "Update FTP Monitor (Change Status)", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 12, "publicId": "00000000-0000-4000-8000-00000000006c", "organizationId": 4, "customerId": 6, "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "checkInterval": 5, "timeoutSeconds": 30, "config": { "user": "monitor-user", "secure": true, "password": null }, "allowedCheckCountryCodes": [ "DE", "US" ], "status": "disabled", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:59:50.732Z", "createdAt": "2026-04-01T20:58:48.039Z", "updatedAt": "2026-04-01T20:59:57.510Z", "ftpConfig": { "user": "monitor-user", "secure": true, "password": null }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/ftp-monitors/:ftpMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused", "allowedCheckCountryCodes": [ "DE", "US" ], "ftpConfig": { "user": "monitor-user", "password": "change-me", "secure": true } } } } } } }, "/api/ftp-monitors/{id}/alert-history": { "get": { "operationId": "getApiFtpMonitorsIdAlertHistory", "summary": "GET /api/ftp-monitors/{id}/alert-history", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/ftp-monitors/{id}/check-history": { "get": { "operationId": "getApiFtpMonitorsIdCheckHistory", "summary": "Get FTP Monitor Check History", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-000000000074", "status": "failure", "errorMessage": "connect ECONNREFUSED 203.0.113.15:21 (control socket)", "warningMessage": null, "timingFtp": null, "diagnostics": null, "checkedAt": "2026-04-01T20:58:48.188Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ftp-monitors/:ftpMonitorPublicId/check-history" } }, "/api/ftp-monitors/{id}/details": { "get": { "operationId": "getApiFtpMonitorsIdDetails", "summary": "Get FTP Monitor Details", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "ftpMonitorId": 12, "monitor": { "id": 12, "publicId": "00000000-0000-4000-8000-00000000006c", "organizationId": 4, "customerId": 6, "name": "Name 039", "hostname": "uptimeify.io", "port": 21, "checkInterval": 5, "timeoutSeconds": 30, "config": { "user": "ftp-user", "secure": "explicit", "password": null }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:58:48.188Z", "createdAt": "2026-04-01T20:58:48.039Z", "updatedAt": "2026-04-01T20:58:48.038Z", "ftpConfig": { "user": "ftp-user", "secure": "explicit", "password": null }, "hasPassword": true }, "latestCheck": { "id": "00000000-0000-4000-8000-000000000074", "ftpMonitorId": 12, "locationId": 8, "status": "failure", "timingTotal": null, "errorMessage": "connect ECONNREFUSED 203.0.113.15:21 (control socket)", "diagnostics": null, "checkedAt": "2026-04-01T20:58:48.188Z", "createdAt": "2026-04-01T20:58:48.195Z" }, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 0, "monthAvgResponse": 0, "yearAvgResponse": 0 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [ { "timestamp": "2026-04-01 20:58:00+00", "responseTime": 0, "status": "success", "success": true, "timingDns": 0, "timingTcp": 0, "timingTls": 0, "timingTtfb": 0, "timingTransfer": 0 } ], "statusData": [ { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "empty" }, { "date": "01.04.", "status": "online" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 1, "successfulChecks": 1 }, "incidents": { "history": [ { "id": 13, "type": "ftp", "status": "open", "startedAt": "2026-04-01T20:58:48.390Z", "endedAt": null, "duration": "44s", "durationMs": 44844, "details": "connect ECONNREFUSED 203.0.113.15:21 (control socket)", "isOngoing": true } ], "total": 1, "ongoing": 1, "totalDowntime": "44s" }, "alerts": { "history": [ { "id": 14, "incidentId": 13, "type": "ftp", "status": "sent", "channelType": "email", "channelName": "Name 040", "channelConfig": { "to": "example@exampleh", "email": "user009@example.test" }, "sentAt": "2026-04-01T20:58:48.935Z", "errorMessage": null }, { "id": 15, "incidentId": 13, "type": "ftp", "status": "sent", "channelType": "sms", "channelName": "Name 041", "channelConfig": { "phoneNumber": "+491234567890" }, "sentAt": "2026-04-01T20:58:48.866Z", "errorMessage": null }, { "id": 16, "incidentId": 13, "type": "ftp", "status": "failed", "channelType": "webhook", "channelName": "Name 042", "channelConfig": { "url": "https://uptimeify.io/webhooks/uptimeify", "method": "POST", "headers": { "Content-Type": "application/json" }, "timeout": 30, "retryDelay": 60, "bodyTemplate": "{\"text\":\"Incident on (): \"}", "retryAttempts": 3, "expectedStatusCodes": "200,201,202", "hasSecret": false }, "sentAt": "2026-04-01T20:58:48.822Z", "errorMessage": "Webhook failed permanently after 1 attempts" } ], "total": 3, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [ { "checkType": "ftp", "status": "failure", "success": false, "statusCode": null, "errorMessage": "connect ECONNREFUSED 203.0.113.15:21 (control socket)", "checkedAt": "2026-04-01T20:58:48.188Z", "responseTimeMs": null, "location": { "name": "Name 028", "code": "ch-zrh" } } ], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ftp-monitors/:ftpMonitorPublicId/details" } }, "/api/ftp-monitors/{id}/incident-history": { "get": { "operationId": "getApiFtpMonitorsIdIncidentHistory", "summary": "GET /api/ftp-monitors/{id}/incident-history", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/ftp-monitors/{id}/trigger-check": { "post": { "operationId": "postApiFtpMonitorsIdTriggerCheck", "summary": "Trigger FTP Check", "tags": [ "Ftp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "ftpMonitorId": 1, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "ftp-monitor-checks-ch-zrh", "ftp-monitor-checks-cz-prg", "ftp-monitor-checks-de-fsn", "ftp-monitor-checks-de-nbg", "ftp-monitor-checks-fi-hel", "ftp-monitor-checks-it-mil", "ftp-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/ftp-monitors/:ftpMonitorPublicId/trigger-check" } }, "/api/health": { "get": { "operationId": "getApiHealth", "summary": "GET /api/health", "tags": [ "Health" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/icmp-monitors": { "get": { "operationId": "getApiIcmpMonitors", "summary": "List ICMP Monitors", "tags": [ "Icmp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 1, "publicId": "00000000-0000-4000-8000-000000000076", "organizationId": 1, "customerId": 1, "name": "Name 043", "hostname": "uptimeify.io", "port": null, "checkInterval": 5, "timeoutSeconds": 10, "config": { "count": 4, "packetSize": 56 }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:00:24.980Z", "updatedAt": "2026-04-01T21:00:24.979Z" } ], "total": 1, "page": 1, "perPage": 50 } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/icmp-monitors" }, "post": { "operationId": "postApiIcmpMonitors", "summary": "Create ICMP Monitor", "tags": [ "Icmp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000076", "organizationId": 1, "customerId": 1, "name": "Name 043", "hostname": "uptimeify.io", "port": null, "checkInterval": 5, "timeoutSeconds": 10, "config": { "count": 4, "packetSize": 56 }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:00:24.980Z", "updatedAt": "2026-04-01T21:00:24.979Z", "icmpConfig": { "count": 4, "packetSize": 56 } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/icmp-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 043", "hostname": "uptimeify.io", "status": "active", "checkInterval": 5, "timeoutSeconds": 10, "icmpConfig": { "packetSize": 56, "count": 4 } } } } } } }, "/api/icmp-monitors/{id}": { "delete": { "operationId": "deleteApiIcmpMonitorsId", "summary": "Delete ICMP Monitor", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/icmp-monitors/:icmpMonitorPublicId" }, "get": { "operationId": "getApiIcmpMonitorsId", "summary": "Get ICMP Monitor", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000076", "organizationId": 1, "customerId": 1, "name": "Name 043", "hostname": "uptimeify.io", "port": null, "checkInterval": 5, "timeoutSeconds": 10, "config": { "count": 4, "packetSize": 56 }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:00:24.980Z", "updatedAt": "2026-04-01T21:00:24.979Z", "icmpConfig": { "count": 4, "packetSize": 56 } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/icmp-monitors/:icmpMonitorPublicId" }, "patch": { "operationId": "patchApiIcmpMonitorsId", "summary": "Update ICMP Monitor", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000076", "organizationId": 1, "customerId": 1, "name": "Name 043", "hostname": "uptimeify.io", "port": null, "checkInterval": 5, "timeoutSeconds": 10, "config": { "count": 4, "packetSize": 56 }, "status": "disabled", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:00:57.514Z", "createdAt": "2026-04-01T21:00:24.980Z", "updatedAt": "2026-04-01T21:01:08.799Z", "icmpConfig": { "count": 4, "packetSize": 56 } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/icmp-monitors/:icmpMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused" } } } } } }, "/api/icmp-monitors/{id}/alert-history": { "get": { "operationId": "getApiIcmpMonitorsIdAlertHistory", "summary": "GET /api/icmp-monitors/{id}/alert-history", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/icmp-monitors/{id}/check-history": { "get": { "operationId": "getApiIcmpMonitorsIdCheckHistory", "summary": "Get ICMP Monitor Check History", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-00000000007e", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 6, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 17, "locationName": "Name 044", "locationCode": "de-nbg" }, { "id": "00000000-0000-4000-8000-000000000080", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 1, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 18, "locationName": "Name 045", "locationCode": "de-fsn" }, { "id": "00000000-0000-4000-8000-000000000082", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 28, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 12, "locationName": "Name 046", "locationCode": "fi-hel" }, { "id": "00000000-0000-4000-8000-000000000084", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 24, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 9, "locationName": "Name 029", "locationCode": "pl-waw" }, { "id": "00000000-0000-4000-8000-000000000086", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 15, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 7, "locationName": "Name 047", "locationCode": "it-mil" }, { "id": "00000000-0000-4000-8000-000000000088", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 14, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 19, "locationName": "Name 048", "locationCode": "cz-prg" }, { "id": "00000000-0000-4000-8000-00000000008a", "status": "success", "errorMessage": null, "warningMessage": null, "timingIcmp": 11, "diagnostics": { "avg": null, "max": null, "min": null, "packetLoss": 0 }, "checkedAt": "2026-04-01T21:00:57.514Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/icmp-monitors/:icmpMonitorPublicId/check-history" } }, "/api/icmp-monitors/{id}/details": { "get": { "operationId": "getApiIcmpMonitorsIdDetails", "summary": "Get ICMP Monitor Details", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "icmpMonitorId": 1, "monitor": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000076", "organizationId": 1, "customerId": 6, "name": "Name 043", "hostname": "uptimeify.io", "port": null, "checkInterval": 5, "timeoutSeconds": 10, "config": { "count": 4, "packetSize": 56 }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:00:24.980Z", "updatedAt": "2026-04-01T21:00:24.979Z" }, "latestCheck": null, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 0, "monthAvgResponse": 0, "yearAvgResponse": 0 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [], "statusData": [ { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "empty" }, { "date": "01.04.", "status": "empty" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "0.00", "totalChecks": 0, "successfulChecks": 0 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0s" }, "alerts": { "history": [], "total": 0, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/icmp-monitors/:icmpMonitorPublicId/details" } }, "/api/icmp-monitors/{id}/incident-history": { "get": { "operationId": "getApiIcmpMonitorsIdIncidentHistory", "summary": "GET /api/icmp-monitors/{id}/incident-history", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/icmp-monitors/{id}/trigger-check": { "post": { "operationId": "postApiIcmpMonitorsIdTriggerCheck", "summary": "Trigger ICMP Check", "tags": [ "Icmp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "icmpMonitorId": 1, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "icmp-monitor-checks-ch-zrh", "icmp-monitor-checks-cz-prg", "icmp-monitor-checks-de-fsn", "icmp-monitor-checks-de-nbg", "icmp-monitor-checks-fi-hel", "icmp-monitor-checks-it-mil", "icmp-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/icmp-monitors/:icmpMonitorPublicId/trigger-check" } }, "/api/imap-pop-monitors": { "get": { "operationId": "getApiImapPopMonitors", "summary": "List IMAP/POP Monitors", "tags": [ "Imap Pop Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 12, "publicId": "00000000-0000-4000-8000-0000000000a7", "organizationId": 4, "customerId": 6, "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "checkInterval": 5, "timeoutSeconds": 30, "config": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:02:00.007Z", "createdAt": "2026-04-01T21:01:39.417Z", "updatedAt": "2026-04-01T21:01:39.416Z", "customer": { "id": 6, "publicId": "00000000-0000-4000-8000-000000000023", "organizationId": 4, "name": "Name 027", "email": "user008@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 7, "packageType": "fullservice", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "companyName": null, "street": null, "postalCode": null, "city": null, "country": null, "vatId": null, "mollieCustomerId": null, "mollieSubscriptionId": null, "customPricing": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "customFields": {}, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 2, "createdAt": "2026-03-18T07:57:21.664Z", "updatedAt": "2026-03-18T07:57:36.415Z" }, "imapPopConfig": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "hasPassword": true }, { "id": 28, "publicId": "00000000-0000-4000-8000-0000000000ad", "organizationId": 4, "customerId": 6, "name": "Name 055", "hostname": "uptimeify.io", "port": 993, "checkInterval": 30, "timeoutSeconds": 30, "config": { "tls": true, "user": "user011@example.test", "password": null, "protocol": "imap", "tlsOptions": { "rejectUnauthorized": true } }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T20:34:00.004Z", "createdAt": "2026-03-18T12:33:30.798Z", "updatedAt": "2026-03-18T12:33:30.797Z", "customer": { "id": 6, "publicId": "00000000-0000-4000-8000-000000000023", "organizationId": 4, "name": "Name 027", "email": "user008@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 7, "packageType": "fullservice", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "companyName": null, "street": null, "postalCode": null, "city": null, "country": null, "vatId": null, "mollieCustomerId": null, "mollieSubscriptionId": null, "customPricing": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "customFields": {}, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 2, "createdAt": "2026-03-18T07:57:21.664Z", "updatedAt": "2026-03-18T07:57:36.415Z" }, "imapPopConfig": { "tls": true, "user": "user011@example.test", "password": null, "protocol": "imap", "tlsOptions": { "rejectUnauthorized": true } }, "hasPassword": true } ], "total": 2, "page": 1, "perPage": 50 } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/imap-pop-monitors" }, "post": { "operationId": "postApiImapPopMonitors", "summary": "Create IMAP/POP Monitor", "tags": [ "Imap Pop Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 12, "publicId": "00000000-0000-4000-8000-0000000000a7", "organizationId": 4, "customerId": 6, "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "checkInterval": 5, "timeoutSeconds": 30, "config": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:01:39.417Z", "updatedAt": "2026-04-01T21:01:39.416Z", "imapPopConfig": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/imap-pop-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "status": "active", "checkInterval": 5, "timeoutSeconds": 30, "imapPopConfig": { "protocol": "imap", "user": "user003@example.test", "password": "change-me", "tls": true } } } } } } }, "/api/imap-pop-monitors/{id}": { "delete": { "operationId": "deleteApiImapPopMonitorsId", "summary": "Delete IMAP/POP Monitor", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/imap-pop-monitors/:imapPopMonitorPublicId" }, "get": { "operationId": "getApiImapPopMonitorsId", "summary": "Get IMAP/POP Monitor", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 12, "publicId": "00000000-0000-4000-8000-0000000000a7", "organizationId": 4, "customerId": 6, "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "checkInterval": 5, "timeoutSeconds": 30, "config": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:01:39.417Z", "updatedAt": "2026-04-01T21:01:39.416Z", "customer": { "id": 6, "publicId": "00000000-0000-4000-8000-000000000023", "organizationId": 4, "name": "Name 027", "email": "user008@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 7, "packageType": "fullservice", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "companyName": null, "street": null, "postalCode": null, "city": null, "country": null, "vatId": null, "mollieCustomerId": null, "mollieSubscriptionId": null, "customPricing": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "customFields": {}, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 2, "createdAt": "2026-03-18T07:57:21.664Z", "updatedAt": "2026-03-18T07:57:36.415Z" }, "imapPopConfig": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/imap-pop-monitors/:imapPopMonitorPublicId" }, "patch": { "operationId": "patchApiImapPopMonitorsId", "summary": "Update IMAP/POP Monitor", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-0000000000a7", "organizationId": 1, "customerId": 1, "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "checkInterval": 5, "timeoutSeconds": 30, "config": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "status": "disabled", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:02:09.539Z", "createdAt": "2026-04-01T21:01:39.417Z", "updatedAt": "2026-04-01T21:02:15.183Z", "imapPopConfig": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "hasPassword": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/imap-pop-monitors/:imapPopMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused" } } } } } }, "/api/imap-pop-monitors/{id}/alert-history": { "get": { "operationId": "getApiImapPopMonitorsIdAlertHistory", "summary": "GET /api/imap-pop-monitors/{id}/alert-history", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/imap-pop-monitors/{id}/check-history": { "get": { "operationId": "getApiImapPopMonitorsIdCheckHistory", "summary": "Get IMAP/POP Monitor Check History", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-0000000000ab", "status": "failure", "errorMessage": "Timed out while connecting to server", "warningMessage": null, "timingImapPop": null, "diagnostics": null, "checkedAt": "2026-04-01T21:02:09.539Z", "locationId": 1, "locationName": "Name 028", "locationCode": "ch-zrh" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/imap-pop-monitors/:imapPopMonitorPublicId/check-history" } }, "/api/imap-pop-monitors/{id}/details": { "get": { "operationId": "getApiImapPopMonitorsIdDetails", "summary": "Get IMAP/POP Monitor Details", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "imapPopMonitorId": 12, "monitor": { "id": 12, "publicId": "00000000-0000-4000-8000-0000000000a7", "organizationId": 4, "customerId": 6, "name": "Name 053", "hostname": "uptimeify.io", "port": 993, "checkInterval": 5, "timeoutSeconds": 30, "config": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:01:39.417Z", "updatedAt": "2026-04-01T21:01:39.416Z", "imapPopConfig": { "tls": true, "user": "user003@example.test", "password": null, "protocol": "imap" }, "hasPassword": true }, "latestCheck": null, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 0, "monthAvgResponse": 0, "yearAvgResponse": 0 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 0, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [], "statusData": [ { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "empty" }, { "date": "01.04.", "status": "empty" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "0.00", "totalChecks": 0, "successfulChecks": 0 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0s" }, "alerts": { "history": [], "total": 0, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/imap-pop-monitors/:imapPopMonitorPublicId/details" } }, "/api/imap-pop-monitors/{id}/incident-history": { "get": { "operationId": "getApiImapPopMonitorsIdIncidentHistory", "summary": "GET /api/imap-pop-monitors/{id}/incident-history", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/imap-pop-monitors/{id}/trigger-check": { "post": { "operationId": "postApiImapPopMonitorsIdTriggerCheck", "summary": "Trigger IMAP/POP Check", "tags": [ "Imap Pop Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "imapPopMonitorId": 1, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "imap-pop-monitor-checks-ch-zrh", "imap-pop-monitor-checks-cz-prg", "imap-pop-monitor-checks-de-fsn", "imap-pop-monitor-checks-de-nbg", "imap-pop-monitor-checks-fi-hel", "imap-pop-monitor-checks-it-mil", "imap-pop-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/imap-pop-monitors/:imapPopMonitorPublicId/trigger-check" } }, "/api/incidents": { "get": { "operationId": "getApiIncidents", "summary": "List Incidents (Organization)", "tags": [ "Incidents" ], "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeTotal", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" }, "example": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000003e", "websiteId": 1, "status": "open", "severity": "downtime", "started_at": "2026-04-01T20:41:03.225Z", "resolved_at": null, "last_notified_at": "2026-04-01T20:41:03.655Z", "error_message": "Unexpected status code (200) (expected: 400)", "status_code": 200, "response_time_ms": 196, "website": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000032", "name": "Name 030", "url": "https://uptimeify.io/", "status": "active" }, "customer": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000023", "email": "user008@example.test", "company": "Organization 001" } } ] } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/incidents?organizationId=:organizationId" } }, "/api/incidents/{id}": { "get": { "operationId": "getApiIncidentsId", "summary": "Get Incident Details", "tags": [ "Incidents" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/incidents/:incidentPublicId" } }, "/api/maintenance-windows": { "get": { "operationId": "getApiMaintenanceWindows", "summary": "List Maintenance Windows", "tags": [ "Maintenance Windows" ], "parameters": [ { "name": "websiteId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "activeOnly", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "icmpMonitorId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "smtpMonitorId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "sshMonitorId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ftpMonitorId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "imapPopMonitorId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" }, "example": [ { "id": 67, "publicId": "00000000-0000-4000-8000-000000000008", "websiteId": 67, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 67, "name": "Name 040", "description": "Description 040", "startTime": "2026-04-01T22:00:00.000Z", "endTime": "2026-04-01T23:00:00.000Z", "isRecurring": false, "recurrencePattern": { "interval": 1, "frequency": "weekly", "daysOfWeek": [ 1 ] }, "isActive": true, "createdBy": "api-token-redacted", "createdAt": "2026-03-31T17:45:04.401Z", "updatedAt": "2026-03-31T17:45:04.401Z", "website": { "id": 67, "publicId": "00000000-0000-4000-8000-000000000014", "customerId": 67, "name": "Name 041", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "inactive", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:44:02.666Z" } } ] } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/maintenance-windows" }, "post": { "operationId": "postApiMaintenanceWindows", "summary": "Create Maintenance Window", "tags": [ "Maintenance Windows" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000009", "websiteId": 1, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 1, "name": "Name 017", "description": "Description 018", "startTime": "2026-04-01T22:00:00.000Z", "endTime": "2026-04-01T23:00:00.000Z", "isRecurring": false, "recurrencePattern": { "interval": 1, "frequency": "weekly", "daysOfWeek": [ 1 ] }, "isActive": true, "createdBy": "redacted-user", "createdAt": "2026-03-31T17:45:04.401Z", "updatedAt": "2026-03-31T17:45:04.401Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/maintenance-windows", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "websiteId": "00000000-0000-4000-8000-000000000005", "name": "Name 017", "description": "Description 018", "startTime": "2026-04-01T22:00:00.000Z", "endTime": "2026-04-01T23:00:00.000Z", "isRecurring": false, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [ 1 ] }, "isActive": true } } } } } }, "/api/maintenance-windows/check/batch": { "post": { "operationId": "postApiMaintenanceWindowsCheckBatch", "summary": "Check Maintenance (Batch)", "tags": [ "Maintenance Windows" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "results": { "144": { "inMaintenance": false, "activeWindows": [] } } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/maintenance-windows/check/batch", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "websiteIds": [ "00000000-0000-4000-8000-000000000005" ] } } } } } }, "/api/maintenance-windows/check/{websiteId}": { "get": { "operationId": "getApiMaintenanceWindowsCheckWebsiteId", "summary": "Check Maintenance (Website)", "tags": [ "Maintenance Windows" ], "parameters": [ { "name": "websiteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "inMaintenance": false, "activeWindows": [] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/maintenance-windows/check/:websiteId" } }, "/api/maintenance-windows/{id}": { "delete": { "operationId": "deleteApiMaintenanceWindowsId", "summary": "Delete Maintenance Window", "tags": [ "Maintenance Windows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/maintenance-windows/:id" }, "get": { "operationId": "getApiMaintenanceWindowsId", "summary": "Get Maintenance Window", "tags": [ "Maintenance Windows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000019", "websiteId": 1, "icmpMonitorId": null, "smtpMonitorId": null, "sshMonitorId": null, "ftpMonitorId": null, "imapPopMonitorId": null, "customerId": 1, "name": "Name 017", "description": "Description 018", "startTime": "2026-04-01T22:00:00.000Z", "endTime": "2026-04-01T23:00:00.000Z", "isRecurring": false, "recurrencePattern": { "interval": 1, "frequency": "weekly", "daysOfWeek": [ 1 ] }, "isActive": true, "createdBy": "redacted-user", "createdAt": "2026-04-04T12:57:03.958Z", "updatedAt": "2026-04-04T12:57:03.958Z", "website": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000005", "customerId": 1, "name": "Name 022", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": false, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": false, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 3, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": 1024, "maxPageSize": 512000, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "active", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-04T12:57:00.003Z", "createdAt": "2026-04-02T14:41:18.649Z", "updatedAt": "2026-04-03T11:28:24.715Z" }, "icmpMonitor": null, "smtpMonitor": null, "sshMonitor": null, "ftpMonitor": null, "imapPopMonitor": null } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/maintenance-windows/:id" }, "patch": { "operationId": "patchApiMaintenanceWindowsId", "summary": "Update Maintenance Window", "tags": [ "Maintenance Windows" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object" }, "example": { "error": true, "url": "https://uptimeify.io/api/maintenance-windows/00000000-0000-4000-8000-000000000014", "statusCode": 404, "statusMessage": "Maintenance window not found", "message": "Maintenance window not found" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/maintenance-windows/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Name 019", "description": null, "startTime": "2026-04-08T22:00:00.000Z", "endTime": "2026-04-08T23:30:00.000Z", "isRecurring": false, "recurrencePattern": { "frequency": "weekly", "interval": 1, "daysOfWeek": [ 1 ] }, "isActive": true } } } } } }, "/api/mollie/invoices": { "get": { "operationId": "getApiMollieInvoices", "summary": "List Invoices", "tags": [ "Mollie" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "invoices": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "reference": "RE250011", "status": "paid", "issuedAt": "2025-12-02T04:52:52.795Z", "netAmount": { "value": "00.00", "currency": "EUR" }, "pdfUrl": "/api/invoices/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/pdf" }, { "id": "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy", "reference": "RE250009", "status": "paid", "issuedAt": "2025-11-24T09:38:03.213Z", "netAmount": { "value": "00.00", "currency": "EUR" }, "pdfUrl": "/api/invoices/yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy/pdf" }, { "id": "zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz", "reference": "Draft", "status": "paid", "issuedAt": "2025-11-24T09:10:01.814Z", "netAmount": { "value": "00.00", "currency": "EUR" }, "pdfUrl": "/api/invoices/zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz/pdf" }, { "id": "00000000-0000-4000-8000-0000000000b0", "reference": "Draft", "status": "paid", "issuedAt": "2025-11-24T08:23:31.806Z", "netAmount": { "value": "00.00", "currency": "EUR" }, "pdfUrl": "/api/invoices/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/pdf" } ] } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organizations/:id/mollie/invoices" } }, "/api/monitor-tags": { "delete": { "operationId": "deleteApiMonitorTags", "summary": "DELETE /api/monitor-tags", "tags": [ "Monitor Tags" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "getApiMonitorTags", "summary": "GET /api/monitor-tags", "tags": [ "Monitor Tags" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postApiMonitorTags", "summary": "POST /api/monitor-tags", "tags": [ "Monitor Tags" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/monitoring-locations/countries": { "get": { "operationId": "getApiMonitoringLocationsCountries", "summary": "List Countries with Locations", "tags": [ "Monitoring Locations" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/monitoring-locations/countries" } }, "/api/monitors/{type}/{id}/change-requests": { "post": { "operationId": "postApiMonitorsTypeIdChangeRequests", "summary": "POST /api/monitors/{type}/{id}/change-requests", "tags": [ "Monitors" ], "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/notification-channels": { "get": { "operationId": "getApiNotificationChannels", "summary": "List Notification Channels", "tags": [ "Notification Channels" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/notification-channels" }, "post": { "operationId": "postApiNotificationChannels", "summary": "Create Notification Channel", "tags": [ "Notification Channels" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/notification-channels", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "type": "email", "name": "My Email Channel", "config": { "email": "alerts@example.com" }, "category": "alert", "priority": 1, "delaySeconds": 0, "conditions": {}, "isActive": true, "organizationId": null, "customerId": null, "websiteId": null, "sourceChannelId": null } } } } } }, "/api/notification-channels/test": { "post": { "operationId": "postApiNotificationChannelsTest", "summary": "Test Notification Channel", "tags": [ "Notification Channels" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/notification-channels/test", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "type": "email", "config": { "email": "alerts@example.com" }, "organizationId": null, "customerId": null, "websiteId": null, "dryRun": false } } } } } }, "/api/notification-channels/{id}": { "delete": { "operationId": "deleteApiNotificationChannelsId", "summary": "Delete Notification Channel", "tags": [ "Notification Channels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/notification-channels/:id" }, "patch": { "operationId": "patchApiNotificationChannelsId", "summary": "Update Notification Channel", "tags": [ "Notification Channels" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/notification-channels/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "type": "email", "name": "Updated Channel", "config": { "email": "alerts@example.com" }, "priority": 1, "delaySeconds": 0, "conditions": {}, "allowedPackageTypes": [], "isActive": true } } } } } }, "/api/oauth/connections": { "get": { "operationId": "getApiOauthConnections", "summary": "GET /api/oauth/connections", "tags": [ "Oauth" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/oauth/connections/{clientId}": { "delete": { "operationId": "deleteApiOauthConnectionsClientId", "summary": "DELETE /api/oauth/connections/{clientId}", "tags": [ "Oauth" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization": { "get": { "operationId": "getApiOrganization", "summary": "Get Organization Profile", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization" }, "patch": { "operationId": "patchApiOrganization", "summary": "Update Organization Profile", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organization" } }, "/api/organization/audit": { "get": { "operationId": "getApiOrganizationAudit", "summary": "Get Organization Audit Log", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/audit" } }, "/api/organization/billing": { "get": { "operationId": "getApiOrganizationBilling", "summary": "Get Organization Billing (Self)", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/billing" }, "patch": { "operationId": "patchApiOrganizationBilling", "summary": "Update Organization Billing (Self)", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organization/billing" } }, "/api/organization/report-runs": { "get": { "operationId": "getApiOrganizationReportRuns", "summary": "GET /api/organization/report-runs", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/report-runs/{id}/pdf": { "get": { "operationId": "getApiOrganizationReportRunsIdPdf", "summary": "GET /api/organization/report-runs/{id}/pdf", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/reports": { "get": { "operationId": "getApiOrganizationReports", "summary": "GET /api/organization/reports", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postApiOrganizationReports", "summary": "POST /api/organization/reports", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/reports/{id}": { "delete": { "operationId": "deleteApiOrganizationReportsId", "summary": "DELETE /api/organization/reports/{id}", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "getApiOrganizationReportsId", "summary": "GET /api/organization/reports/{id}", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiOrganizationReportsId", "summary": "PATCH /api/organization/reports/{id}", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/reports/{id}/send-now": { "post": { "operationId": "postApiOrganizationReportsIdSendNow", "summary": "POST /api/organization/reports/{id}/send-now", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/smtp": { "get": { "operationId": "getApiOrganizationSmtp", "summary": "Get SMTP Configuration", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/smtp" }, "patch": { "operationId": "patchApiOrganizationSmtp", "summary": "Update SMTP Configuration", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organization/smtp" } }, "/api/organization/smtp/logs": { "get": { "operationId": "getApiOrganizationSmtpLogs", "summary": "Get SMTP Logs", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organization/smtp/test": { "post": { "operationId": "postApiOrganizationSmtpTest", "summary": "Test SMTP", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "toEmail": "admin@example.com", "subject": "SMTP Test", "message": "This is a test email from Uptimeify.", "host": "smtp.example.com", "port": 587, "tlsMode": "starttls", "username": "alerts@example.com", "password": "your-password", "fromName": "Uptimeify Alerts", "fromEmail": "alerts@example.com" } } } } } }, "/api/organization/tokens": { "get": { "operationId": "getApiOrganizationTokens", "summary": "List Organization Tokens", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/tokens" }, "post": { "operationId": "postApiOrganizationTokens", "summary": "Create Organization Token", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/organization/tokens", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "My Org API Token", "expiresInDays": 365, "customerId": null } } } } } }, "/api/organization/tokens/{id}": { "delete": { "operationId": "deleteApiOrganizationTokensId", "summary": "Delete Organization Token", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/organization/tokens/:id" } }, "/api/organization/whitelabel/branding": { "get": { "operationId": "getApiOrganizationWhitelabelBranding", "summary": "Get Branding", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/whitelabel/branding" }, "patch": { "operationId": "patchApiOrganizationWhitelabelBranding", "summary": "Update Branding", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organization/whitelabel/branding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "productName": "MyProduct", "hideProductName": false, "hideLogos": false, "themePrimary": "#3b82f6", "themeNeutral": "#64748b" } } } } } }, "/api/organization/whitelabel/branding/upload": { "post": { "operationId": "postApiOrganizationWhitelabelBrandingUpload", "summary": "Upload Branding Asset", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "kind": "logoLight", "fileName": "logo.svg", "dataUrl": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48L3N2Zz4=" } } } } } }, "/api/organization/whitelabel/domains": { "get": { "operationId": "getApiOrganizationWhitelabelDomains", "summary": "List Domains", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organization/whitelabel/domains" }, "post": { "operationId": "postApiOrganizationWhitelabelDomains", "summary": "Add Domain", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/organization/whitelabel/domains", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "hostname": "status.example.com" } } } } } }, "/api/organization/whitelabel/domains/activate": { "post": { "operationId": "postApiOrganizationWhitelabelDomainsActivate", "summary": "Activate Domain", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/organization/whitelabel/domains/activate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "domainId": "00000000-0000-4000-8000-000000000001", "makePrimary": false } } } } } }, "/api/organization/whitelabel/domains/verify": { "post": { "operationId": "postApiOrganizationWhitelabelDomainsVerify", "summary": "Verify Domain", "tags": [ "Organization" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/organization/whitelabel/domains/verify", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "domainId": "00000000-0000-4000-8000-000000000001" } } } } } }, "/api/organization/whitelabel/domains/{id}": { "delete": { "operationId": "deleteApiOrganizationWhitelabelDomainsId", "summary": "Delete Domain", "tags": [ "Organization" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/organization/whitelabel/domains/:id" } }, "/api/organizations": { "get": { "operationId": "getApiOrganizations", "summary": "Get Organization Details", "tags": [ "Organizations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 4, "publicId": "00000000-0000-4000-8000-0000000000af", "name": "Name 059", "billingEmail": "user004@example.test", "paymentMethod": "mollie", "quotaWebsitesLimit": 10, "quotaIpsLimit": 10, "quotaSmsIncluded": 0, "quotaMonthlyPriceCents": 0, "quotaExtraSmsPriceCents": 0, "quotaEffectiveAt": "2026-03-30T18:18:30.027Z", "quotaAutoUpgradeEnabled": false, "smsOverageSafetyCapCentsMonthly": null, "smsOverageCapLastAlertedPeriod": null, "smsOverageCapLastAlertedAt": null, "smsOverageCapBlockedAt": null, "smsOverageCapBlockedReason": null, "mollieCustomerId": "id", "mollieSubscriptionId": "id", "billingCycle": "monthly", "nextBillingDate": null, "companyName": "Organization 001", "street": "New Street", "postalCode": "54321", "city": "New City", "country": "US", "vatId": "US123", "defaultPhoneNumber": null, "defaultEmail": null, "defaultNotificationChannels": { "sms": false, "email": true, "webhook": true, "integrations": false }, "defaultNotificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" }, "defaultNotificationRules": null, "status": "active", "cancellationDate": null, "cancelledAt": null, "failedPaymentCount": 0, "lastFailedAt": null, "gracePeriodEndsAt": null, "suspendedAt": null, "lastDunningEmailSentAt": null, "dunningLevel": 0, "createdAt": "2025-12-20T17:46:48.870Z", "updatedAt": "2026-03-30T18:18:30.027Z" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organizations/:organizationPublicId" }, "patch": { "operationId": "patchApiOrganizations", "summary": "Update Organization", "tags": [ "Organizations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 4, "publicId": "00000000-0000-4000-8000-0000000000af", "name": "Name 061", "billingEmail": "user004@example.test", "paymentMethod": "mollie", "quotaWebsitesLimit": 10, "quotaIpsLimit": 10, "quotaSmsIncluded": 0, "quotaMonthlyPriceCents": 0, "quotaExtraSmsPriceCents": 0, "quotaEffectiveAt": "2026-03-30T18:18:30.027Z", "quotaAutoUpgradeEnabled": false, "smsOverageSafetyCapCentsMonthly": null, "smsOverageCapLastAlertedPeriod": null, "smsOverageCapLastAlertedAt": null, "smsOverageCapBlockedAt": null, "smsOverageCapBlockedReason": null, "mollieCustomerId": "cst_QjNUmwNgPW", "mollieSubscriptionId": "tr_mV9iDLjzSEXTv24vfRcJJ", "billingCycle": "monthly", "nextBillingDate": null, "companyName": "Organization 001", "street": "Organization 001 Street 1", "postalCode": "10115", "city": "Berlin", "country": "DE", "vatId": "00000000-0000-4000-8000-0000000000b1", "defaultPhoneNumber": null, "defaultEmail": null, "defaultNotificationChannels": { "sms": false, "email": true, "webhook": true, "integrations": false }, "defaultNotificationTargets": { "sms": "both", "email": "user012@example.test", "webhook": "organization", "integrations": "both" }, "defaultNotificationRules": null, "status": "active", "cancellationDate": null, "cancelledAt": null, "failedPaymentCount": 0, "lastFailedAt": null, "gracePeriodEndsAt": null, "suspendedAt": null, "lastDunningEmailSentAt": null, "dunningLevel": 0, "createdAt": "2025-12-20T17:46:48.870Z", "updatedAt": "2026-04-01T21:11:57.387Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organizations/:organizationPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "name": "Name 061", "companyName": "Organization 001", "street": "Organization 001 Street 1", "postalCode": "10115", "city": "Berlin", "country": "DE", "vatId": "00000000-0000-4000-8000-0000000000b1", "email": "user004@example.test", "defaultNotificationChannels": { "email": true, "sms": false, "webhook": true, "integrations": false }, "defaultNotificationTargets": { "email": "user012@example.test", "sms": "both", "webhook": "organization", "integrations": "both" } } } } } } }, "/api/organizations/billing": { "get": { "operationId": "getApiOrganizationsBilling", "summary": "Get Billing Details", "tags": [ "Organizations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "billingEmail": "user004@example.test", "paymentMethod": "mollie" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organizations/:id/billing" }, "patch": { "operationId": "patchApiOrganizationsBilling", "summary": "Update Billing Details", "tags": [ "Organizations" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "billingEmail": "user004@example.test" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organizations/:id/billing", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "billingEmail": "user004@example.test" } } } } } }, "/api/organizations/package-configs/{packageType}": { "delete": { "operationId": "deleteApiOrganizationsPackageConfigsPackageType", "summary": "Delete Package Config", "tags": [ "Organizations" ], "parameters": [ { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/organizations/:id/package-configs/:packageType" }, "patch": { "operationId": "patchApiOrganizationsPackageConfigsPackageType", "summary": "Upsert Package Config", "tags": [ "Organizations" ], "parameters": [ { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 29, "organizationId": 4, "packageType": "new", "displayName": "Name 063", "maxUrls": 100, "allowedCheckCountryCodes": null, "dataRetentionMonths": 12, "checkIntervalMinutes": 1, "checkLocations": 3, "notificationDelayMinutes": 0, "reminderDelayMinutes": 10, "alertConsecutiveChecks": 3, "alertLocationThreshold": "majority", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "enableSslCheck": true, "enableHttpsCheck": false, "enableStatusCheck": true, "enableSizeCheck": false, "enableResponseTimeCheck": false, "enableKeywordCheck": false, "enableDomainExpiryCheck": true, "enableEmailAlerts": true, "enableSmsAlerts": true, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": true, "enablePdfReports": true, "notes": "Default for PRO customers", "createdAt": "2026-04-01T21:13:50.007Z", "updatedAt": "2026-04-01T21:13:50.007Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/organizations/:id/package-configs/:packageType" } }, "/api/organizations/{id}": { "get": { "operationId": "getApiOrganizationsId", "summary": "GET /api/organizations/{id}", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiOrganizationsId", "summary": "PATCH /api/organizations/{id}", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organizations/{id}/billing": { "get": { "operationId": "getApiOrganizationsIdBilling", "summary": "GET /api/organizations/{id}/billing", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiOrganizationsIdBilling", "summary": "PATCH /api/organizations/{id}/billing", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organizations/{id}/mollie/invoices": { "get": { "operationId": "getApiOrganizationsIdMollieInvoices", "summary": "GET /api/organizations/{id}/mollie/invoices", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organizations/{id}/package-configs": { "get": { "operationId": "getApiOrganizationsIdPackageConfigs", "summary": "GET /api/organizations/{id}/package-configs", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/organizations/{id}/package-configs/{packageType}": { "delete": { "operationId": "deleteApiOrganizationsIdPackageConfigsPackageType", "summary": "DELETE /api/organizations/{id}/package-configs/{packageType}", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiOrganizationsIdPackageConfigsPackageType", "summary": "PATCH /api/organizations/{id}/package-configs/{packageType}", "tags": [ "Organizations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/package-configs": { "get": { "operationId": "getApiPackageConfigs", "summary": "List Package Configs", "tags": [ "Package Configs" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" }, "example": [ { "id": 4, "organizationId": 4, "packageType": "earlybird", "displayName": null, "maxUrls": 3, "allowedCheckCountryCodes": null, "dataRetentionMonths": 16, "checkIntervalMinutes": 5, "checkLocations": 1, "notificationDelayMinutes": null, "reminderDelayMinutes": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 1, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "enableSslCheck": true, "enableHttpsCheck": false, "enableStatusCheck": true, "enableSizeCheck": false, "enableResponseTimeCheck": false, "enableKeywordCheck": false, "enableDomainExpiryCheck": true, "enableEmailAlerts": true, "enableSmsAlerts": false, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": false, "enablePdfReports": false, "enableSupportTeamAlerts": false, "notes": "", "createdAt": "2025-12-20T17:52:05.304Z", "updatedAt": "2025-12-20T17:52:05.304Z", "usedByCustomerCount": 0 }, { "id": 9, "organizationId": 4, "packageType": "essential", "displayName": null, "maxUrls": 5, "allowedCheckCountryCodes": null, "dataRetentionMonths": 16, "checkIntervalMinutes": 1, "checkLocations": 2, "notificationDelayMinutes": null, "reminderDelayMinutes": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 1, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "enableSslCheck": true, "enableHttpsCheck": true, "enableStatusCheck": true, "enableSizeCheck": false, "enableResponseTimeCheck": false, "enableKeywordCheck": false, "enableDomainExpiryCheck": true, "enableEmailAlerts": false, "enableSmsAlerts": false, "enableWebhookAlerts": true, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": false, "enablePdfReports": false, "enableSupportTeamAlerts": false, "notes": "", "createdAt": "2025-12-20T17:52:26.298Z", "updatedAt": "2025-12-20T17:56:05.799Z", "usedByCustomerCount": 0 }, { "id": 7, "organizationId": 4, "packageType": "fullservice", "displayName": null, "maxUrls": 50, "allowedCheckCountryCodes": null, "dataRetentionMonths": 16, "checkIntervalMinutes": 1, "checkLocations": 6, "notificationDelayMinutes": null, "reminderDelayMinutes": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 1, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "enableSslCheck": true, "enableHttpsCheck": true, "enableStatusCheck": true, "enableSizeCheck": true, "enableResponseTimeCheck": true, "enableKeywordCheck": true, "enableDomainExpiryCheck": true, "enableEmailAlerts": true, "enableSmsAlerts": true, "enableWebhookAlerts": false, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": true, "enablePdfReports": true, "enableSupportTeamAlerts": true, "notes": "", "createdAt": "2025-12-23T08:21:09.554Z", "updatedAt": "2025-12-24T15:40:30.436Z", "usedByCustomerCount": 1 }, { "id": 5, "organizationId": 4, "packageType": "business", "displayName": null, "maxUrls": null, "allowedCheckCountryCodes": null, "dataRetentionMonths": 16, "checkIntervalMinutes": null, "checkLocations": null, "notificationDelayMinutes": null, "reminderDelayMinutes": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 1, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "enableSslCheck": true, "enableHttpsCheck": false, "enableStatusCheck": true, "enableSizeCheck": false, "enableResponseTimeCheck": false, "enableKeywordCheck": false, "enableDomainExpiryCheck": true, "enableEmailAlerts": true, "enableSmsAlerts": false, "enableWebhookAlerts": false, "enableIntegrationAlerts": true, "enablePostRequestEscalation": false, "enableMaintenanceWindows": false, "enablePdfReports": false, "enableSupportTeamAlerts": false, "notes": null, "createdAt": "2026-03-04T12:48:12.402Z", "updatedAt": "2026-03-04T12:48:12.402Z", "usedByCustomerCount": 0 } ] } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/organizations/:id/package-configs" }, "patch": { "operationId": "patchApiPackageConfigs", "summary": "PATCH /api/package-configs", "tags": [ "Package Configs" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/package-configs/{packageType}": { "delete": { "operationId": "deleteApiPackageConfigsPackageType", "summary": "Delete Package Config (Self)", "tags": [ "Package Configs" ], "parameters": [ { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/package-configs/:packageType" }, "patch": { "operationId": "patchApiPackageConfigsPackageType", "summary": "Update Package Config (Self)", "tags": [ "Package Configs" ], "parameters": [ { "name": "packageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/package-configs/:packageType" } }, "/api/public/monitoring-locations": { "get": { "operationId": "getApiPublicMonitoringLocations", "summary": "List Public Monitoring Locations", "tags": [ "Public" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/public/monitoring-locations" } }, "/api/smtp-monitors": { "get": { "operationId": "getApiSmtpMonitors", "summary": "List SMTP Monitors", "tags": [ "Smtp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000008c", "organizationId": 1, "customerId": 1, "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "checkInterval": 5, "timeoutSeconds": 30, "config": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:03:00.005Z", "createdAt": "2026-04-01T21:02:45.918Z", "updatedAt": "2026-04-01T21:02:45.917Z", "smtpConfig": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "hasAuthPass": true } ], "total": 1, "page": 1, "perPage": 50 } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/smtp-monitors" }, "post": { "operationId": "postApiSmtpMonitors", "summary": "Create SMTP Monitor", "tags": [ "Smtp Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000008c", "organizationId": 1, "customerId": 1, "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "checkInterval": 5, "timeoutSeconds": 30, "config": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:02:45.918Z", "updatedAt": "2026-04-01T21:02:45.917Z", "smtpConfig": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "hasAuthPass": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/smtp-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "status": "active", "checkInterval": 5, "timeoutSeconds": 30, "smtpConfig": { "secure": false, "ignoreTls": false, "requireTls": true, "auth": { "user": "smtp-user", "pass": "change-me" } } } } } } } }, "/api/smtp-monitors/{id}": { "delete": { "operationId": "deleteApiSmtpMonitorsId", "summary": "Delete SMTP Monitor", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/smtp-monitors/:smtpMonitorPublicId" }, "get": { "operationId": "getApiSmtpMonitorsId", "summary": "Get SMTP Monitor", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000008c", "organizationId": 1, "customerId": 1, "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "checkInterval": 5, "timeoutSeconds": 30, "config": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:02:45.918Z", "updatedAt": "2026-04-01T21:02:45.917Z", "smtpConfig": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "hasAuthPass": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/smtp-monitors/:smtpMonitorPublicId" }, "patch": { "operationId": "patchApiSmtpMonitorsId", "summary": "Update SMTP Monitor", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000008c", "organizationId": 1, "customerId": 1, "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "checkInterval": 5, "timeoutSeconds": 30, "config": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "status": "disabled", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:03:00.005Z", "createdAt": "2026-04-01T21:02:45.918Z", "updatedAt": "2026-04-01T21:04:07.759Z", "smtpConfig": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "hasAuthPass": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/smtp-monitors/:smtpMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused" } } } } } }, "/api/smtp-monitors/{id}/alert-history": { "get": { "operationId": "getApiSmtpMonitorsIdAlertHistory", "summary": "GET /api/smtp-monitors/{id}/alert-history", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/smtp-monitors/{id}/check-history": { "get": { "operationId": "getApiSmtpMonitorsIdCheckHistory", "summary": "Get SMTP Monitor Check History", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-000000000094", "status": "failure", "errorMessage": "Connection timeout", "warningMessage": null, "timingSmtp": null, "diagnostics": null, "checkedAt": "2026-04-01T21:03:16.081Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" }, { "id": "00000000-0000-4000-8000-000000000096", "status": "failure", "errorMessage": "Connection timeout", "warningMessage": null, "timingSmtp": null, "diagnostics": null, "checkedAt": "2026-04-01T21:03:00.005Z", "locationId": 12, "locationName": "Name 046", "locationCode": "fi-hel" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/smtp-monitors/:smtpMonitorPublicId/check-history" } }, "/api/smtp-monitors/{id}/details": { "get": { "operationId": "getApiSmtpMonitorsIdDetails", "summary": "Get SMTP Monitor Details", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "smtpMonitorId": 1, "monitor": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000008c", "organizationId": 1, "customerId": 1, "name": "Name 049", "hostname": "uptimeify.io", "port": 587, "checkInterval": 5, "timeoutSeconds": 30, "config": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:03:00.005Z", "createdAt": "2026-04-01T21:02:45.918Z", "updatedAt": "2026-04-01T21:02:45.917Z", "smtpConfig": { "auth": { "pass": null, "user": "smtp-user" }, "secure": false, "ignoreTls": false, "requireTls": true }, "hasAuthPass": true }, "latestCheck": { "id": "00000000-0000-4000-8000-000000000094", "smtpMonitorId": 1, "locationId": 8, "status": "failure", "timingTotal": null, "errorMessage": "Connection timeout", "diagnostics": null, "checkedAt": "2026-04-01T21:03:16.081Z", "createdAt": "2026-04-01T21:03:16.160Z" }, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 0, "monthAvgResponse": 0, "yearAvgResponse": 0 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 1 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 1 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 1 } }, "monitoringData": { "responseTimeData": [ { "timestamp": "2026-04-01 21:03:00+00", "responseTime": 0, "status": "error", "success": false, "timingDns": 0, "timingTcp": 0, "timingTls": 0, "timingTtfb": 0, "timingTransfer": 0 } ], "statusData": [ { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "empty" }, { "date": "01.04.", "status": "offline" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "0.00", "totalChecks": 1, "successfulChecks": 0 }, "incidents": { "history": [ { "id": 20, "type": "smtp", "status": "open", "startedAt": "2026-04-01T21:03:16.332Z", "endedAt": null, "duration": "28s", "durationMs": 28287, "details": "Connection timeout", "isOngoing": true } ], "total": 1, "ongoing": 1, "totalDowntime": "28s" }, "alerts": { "history": [ { "id": 21, "incidentId": 20, "type": "smtp", "status": "sent", "channelType": "email", "channelName": "Name 040", "channelConfig": { "to": "example@exampleh", "email": "user009@example.test" }, "sentAt": "2026-04-01T21:03:17.030Z", "errorMessage": null }, { "id": 22, "incidentId": 20, "type": "smtp", "status": "sent", "channelType": "sms", "channelName": "Name 041", "channelConfig": { "phoneNumber": "+491234567890" }, "sentAt": "2026-04-01T21:03:17.003Z", "errorMessage": null }, { "id": 23, "incidentId": 20, "type": "smtp", "status": "failed", "channelType": "webhook", "channelName": "Name 042", "channelConfig": { "url": "https://uptimeify.io/webhooks/uptimeify", "method": "POST", "headers": { "Content-Type": "application/json" }, "timeout": 30, "retryDelay": 60, "bodyTemplate": "{\"text\":\"Incident on (): \"}", "retryAttempts": 3, "expectedStatusCodes": "200,201,202", "hasSecret": false }, "sentAt": "2026-04-01T21:03:16.926Z", "errorMessage": "Webhook failed permanently after 1 attempts" } ], "total": 3, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [ { "checkType": "smtp", "status": "failure", "success": false, "statusCode": null, "errorMessage": "Connection timeout", "checkedAt": "2026-04-01T21:03:16.081Z", "responseTimeMs": null, "location": { "name": "Name 028", "code": "ch-zrh" } }, { "checkType": "smtp", "status": "failure", "success": false, "statusCode": null, "errorMessage": "Connection timeout", "checkedAt": "2026-04-01T21:03:00.005Z", "responseTimeMs": null, "location": { "name": "Name 046", "code": "fi-hel" } } ], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/smtp-monitors/:smtpMonitorPublicId/details" } }, "/api/smtp-monitors/{id}/incident-history": { "get": { "operationId": "getApiSmtpMonitorsIdIncidentHistory", "summary": "GET /api/smtp-monitors/{id}/incident-history", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/smtp-monitors/{id}/trigger-check": { "post": { "operationId": "postApiSmtpMonitorsIdTriggerCheck", "summary": "Trigger Check for SMTP Monitor", "tags": [ "Smtp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "smtpMonitorId": 12, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "smtp-monitor-checks-ch-zrh", "smtp-monitor-checks-cz-prg", "smtp-monitor-checks-de-fsn", "smtp-monitor-checks-de-nbg", "smtp-monitor-checks-fi-hel", "smtp-monitor-checks-it-mil", "smtp-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/smtp-monitors/:smtpMonitorPublicId/trigger-check" } }, "/api/ssh-monitors": { "get": { "operationId": "getApiSshMonitors", "summary": "List SSH Monitors", "tags": [ "Ssh Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 1, "publicId": "00000000-0000-4000-8000-00000000009d", "organizationId": 1, "customerId": 1, "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "checkInterval": 5, "timeoutSeconds": 15, "config": { "password": null, "username": "Name 052" }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:05:00.514Z", "createdAt": "2026-04-01T21:04:57.394Z", "updatedAt": "2026-04-01T21:04:57.393Z", "sshConfig": { "password": null, "username": "Name 052" }, "hasPassword": true, "hasPrivateKey": false } ], "total": 1, "page": 1, "perPage": 50 } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ssh-monitors" }, "post": { "operationId": "postApiSshMonitors", "summary": "Create SSH Monitor", "tags": [ "Ssh Monitors" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-000000000097", "organizationId": 1, "customerId": 6, "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "checkInterval": 5, "timeoutSeconds": 15, "config": { "password": null, "username": "Name 052" }, "allowedCheckCountryCodes": null, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-04-01T21:04:57.394Z", "updatedAt": "2026-04-01T21:04:57.393Z", "sshConfig": { "password": null, "username": "Name 052" }, "hasPassword": true, "hasPrivateKey": false } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/ssh-monitors", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000046", "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "status": "active", "checkInterval": 5, "timeoutSeconds": 15, "sshConfig": { "username": "Name 052", "password": "change-me" } } } } } } }, "/api/ssh-monitors/{id}": { "delete": { "operationId": "deleteApiSshMonitorsId", "summary": "Delete SSH Monitor", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/ssh-monitors/:sshMonitorPublicId" }, "get": { "operationId": "getApiSshMonitorsId", "summary": "Get SSH Monitor", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000009d", "organizationId": 1, "customerId": 1, "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "checkInterval": 5, "timeoutSeconds": 15, "config": { "password": null, "username": "Name 052" }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:05:00.514Z", "createdAt": "2026-04-01T21:04:57.394Z", "updatedAt": "2026-04-01T21:04:57.393Z", "sshConfig": { "password": null, "username": "Name 052" }, "hasPassword": true, "hasPrivateKey": false } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ssh-monitors/:sshMonitorPublicId" }, "patch": { "operationId": "patchApiSshMonitorsId", "summary": "Update SSH Monitor", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000009d", "organizationId": 1, "customerId": 6, "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "checkInterval": 5, "timeoutSeconds": 15, "config": { "password": null, "username": "Name 052" }, "allowedCheckCountryCodes": null, "status": "disabled", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:06:42.831Z", "createdAt": "2026-04-01T21:04:57.394Z", "updatedAt": "2026-04-01T21:06:48.068Z", "sshConfig": { "password": null, "username": "Name 052" }, "hasPassword": true, "hasPrivateKey": false } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/ssh-monitors/:sshMonitorPublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused" } } } } } }, "/api/ssh-monitors/{id}/alert-history": { "get": { "operationId": "getApiSshMonitorsIdAlertHistory", "summary": "GET /api/ssh-monitors/{id}/alert-history", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/ssh-monitors/{id}/check-history": { "get": { "operationId": "getApiSshMonitorsIdCheckHistory", "summary": "Get SSH Monitor Check History", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-0000000000a1", "status": "failure", "errorMessage": "All configured authentication methods failed", "warningMessage": null, "timingSsh": null, "diagnostics": null, "checkedAt": "2026-04-01T21:05:00.514Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ssh-monitors/:sshMonitorPublicId/check-history" } }, "/api/ssh-monitors/{id}/details": { "get": { "operationId": "getApiSshMonitorsIdDetails", "summary": "Get SSH Monitor Details", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "sshMonitorId": 1, "monitor": { "id": 1, "publicId": "00000000-0000-4000-8000-00000000009d", "organizationId": 1, "customerId": 6, "name": "Name 051", "hostname": "uptimeify.io", "port": 22, "checkInterval": 5, "timeoutSeconds": 15, "config": { "password": null, "username": "Name 052" }, "status": "active", "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-04-01T21:05:00.514Z", "createdAt": "2026-04-01T21:04:57.394Z", "updatedAt": "2026-04-01T21:04:57.393Z", "sshConfig": { "password": null, "username": "Name 052" }, "hasPassword": true, "hasPrivateKey": false }, "latestCheck": { "id": "00000000-0000-4000-8000-0000000000a1", "sshMonitorId": 1, "locationId": 8, "status": "failure", "timingTotal": null, "errorMessage": "All configured authentication methods failed", "diagnostics": null, "checkedAt": "2026-04-01T21:05:00.514Z", "createdAt": "2026-04-01T21:05:00.521Z" }, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 0, "monthAvgResponse": 0, "yearAvgResponse": 0 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 1, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [ { "timestamp": "2026-04-01 21:05:00+00", "responseTime": 0, "status": "success", "success": true, "timingDns": 0, "timingTcp": 0, "timingTls": 0, "timingTtfb": 0, "timingTransfer": 0 } ], "statusData": [ { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "empty" }, { "date": "01.04.", "status": "online" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 1, "successfulChecks": 1 }, "incidents": { "history": [ { "id": 24, "type": "ssh", "status": "open", "startedAt": "2026-04-01T21:05:00.702Z", "endedAt": null, "duration": "53s", "durationMs": 53437, "details": "All configured authentication methods failed", "isOngoing": true } ], "total": 1, "ongoing": 1, "totalDowntime": "53s" }, "alerts": { "history": [ { "id": 25, "incidentId": 24, "type": "ssh", "status": "sent", "channelType": "sms", "channelName": "Name 041", "channelConfig": { "phoneNumber": "+491234567890" }, "sentAt": "2026-04-01T21:05:01.730Z", "errorMessage": null }, { "id": 26, "incidentId": 24, "type": "ssh", "status": "sent", "channelType": "email", "channelName": "Name 040", "channelConfig": { "to": "example@exampleh", "email": "user009@example.test" }, "sentAt": "2026-04-01T21:05:01.687Z", "errorMessage": null }, { "id": 27, "incidentId": 24, "type": "ssh", "status": "failed", "channelType": "webhook", "channelName": "Name 042", "channelConfig": { "url": "https://uptimeify.io/webhooks/uptimeify", "method": "POST", "headers": { "Content-Type": "application/json" }, "timeout": 30, "retryDelay": 60, "bodyTemplate": "{\"text\":\"Incident on (): \"}", "retryAttempts": 3, "expectedStatusCodes": "200,201,202", "hasSecret": false }, "sentAt": "2026-04-01T21:05:01.645Z", "errorMessage": "Webhook failed permanently after 1 attempts" } ], "total": 3, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [ { "checkType": "ssh", "status": "failure", "success": false, "statusCode": null, "errorMessage": "All configured authentication methods failed", "checkedAt": "2026-04-01T21:05:00.514Z", "responseTimeMs": null, "location": { "name": "Name 028", "code": "ch-zrh" } } ], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/ssh-monitors/:sshMonitorPublicId/details" } }, "/api/ssh-monitors/{id}/incident-history": { "get": { "operationId": "getApiSshMonitorsIdIncidentHistory", "summary": "GET /api/ssh-monitors/{id}/incident-history", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/ssh-monitors/{id}/trigger-check": { "post": { "operationId": "postApiSshMonitorsIdTriggerCheck", "summary": "Trigger Check for SSH Monitor", "tags": [ "Ssh Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "message": "Checks triggered successfully", "sshMonitorId": 1, "locationCodes": [ "ch-zrh", "cz-prg", "de-fsn", "de-nbg", "fi-hel", "it-mil", "pl-waw" ], "queueNames": [ "ssh-monitor-checks-ch-zrh", "ssh-monitor-checks-cz-prg", "ssh-monitor-checks-de-fsn", "ssh-monitor-checks-de-nbg", "ssh-monitor-checks-fi-hel", "ssh-monitor-checks-it-mil", "ssh-monitor-checks-pl-waw" ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/ssh-monitors/:sshMonitorPublicId/trigger-check" } }, "/api/status-pages": { "get": { "operationId": "getApiStatusPages", "summary": "List Status Pages", "tags": [ "Status Pages" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/status-pages" }, "post": { "operationId": "postApiStatusPages", "summary": "Create Status Page", "tags": [ "Status Pages" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/status-pages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000001", "name": "My Status Page", "slug": "my-status-page", "description": "Status page description", "visibility": "public", "isPublished": false, "customDomainHostname": null } } } } } }, "/api/status-pages/domains": { "post": { "operationId": "postApiStatusPagesDomains", "summary": "Add Custom Domain to Status Page", "tags": [ "Status Pages" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/status-pages/domains", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "statusPageId": 1, "hostname": "status.example.com" } } } } } }, "/api/status-pages/domains/activate": { "post": { "operationId": "postApiStatusPagesDomainsActivate", "summary": "Activate Status Page Domain", "tags": [ "Status Pages" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/status-pages/domains/activate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "domainId": "00000000-0000-4000-8000-000000000001" } } } } } }, "/api/status-pages/domains/verify": { "post": { "operationId": "postApiStatusPagesDomainsVerify", "summary": "Verify Status Page Domain", "tags": [ "Status Pages" ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/status-pages/domains/verify", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "domainId": "00000000-0000-4000-8000-000000000001" } } } } } }, "/api/status-pages/domains/{id}": { "delete": { "operationId": "deleteApiStatusPagesDomainsId", "summary": "Remove Custom Domain from Status Page", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/status-pages/domains/:id" } }, "/api/status-pages/public/by-id/{id}": { "get": { "operationId": "getApiStatusPagesPublicByIdId", "summary": "Get Public Status Page by ID", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/status-pages/public/by-id/:id" } }, "/api/status-pages/public/{slug}": { "get": { "operationId": "getApiStatusPagesPublicSlug", "summary": "Get Public Status Page", "tags": [ "Status Pages" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/status-pages/public/:slug" } }, "/api/status-pages/{id}": { "delete": { "operationId": "deleteApiStatusPagesId", "summary": "Delete Status Page", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/status-pages/:id" }, "patch": { "operationId": "patchApiStatusPagesId", "summary": "Update Status Page", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/status-pages/:id", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000001", "name": "Updated Status Page", "slug": "updated-status-page", "description": "Updated description", "visibility": "public", "isPublished": true, "showRecentIncidents": true, "showRecentMaintenance": true } } } } } }, "/api/status-pages/{id}/design": { "get": { "operationId": "getApiStatusPagesIdDesign", "summary": "Get Status Page Design", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/status-pages/:id/design" }, "patch": { "operationId": "patchApiStatusPagesIdDesign", "summary": "Update Status Page Design", "tags": [ "Status Pages" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/status-pages/:id/design" } }, "/api/tags": { "get": { "operationId": "getApiTags", "summary": "GET /api/tags", "tags": [ "Tags" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postApiTags", "summary": "POST /api/tags", "tags": [ "Tags" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tags/{id}": { "delete": { "operationId": "deleteApiTagsId", "summary": "DELETE /api/tags/{id}", "tags": [ "Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiTagsId", "summary": "PATCH /api/tags/{id}", "tags": [ "Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors": { "get": { "operationId": "getApiTcpMonitors", "summary": "GET /api/tcp-monitors", "tags": [ "Tcp Monitors" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "postApiTcpMonitors", "summary": "POST /api/tcp-monitors", "tags": [ "Tcp Monitors" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}": { "delete": { "operationId": "deleteApiTcpMonitorsId", "summary": "DELETE /api/tcp-monitors/{id}", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "getApiTcpMonitorsId", "summary": "GET /api/tcp-monitors/{id}", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "patchApiTcpMonitorsId", "summary": "PATCH /api/tcp-monitors/{id}", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}/alert-history": { "get": { "operationId": "getApiTcpMonitorsIdAlertHistory", "summary": "GET /api/tcp-monitors/{id}/alert-history", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}/check-history": { "get": { "operationId": "getApiTcpMonitorsIdCheckHistory", "summary": "GET /api/tcp-monitors/{id}/check-history", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}/details": { "get": { "operationId": "getApiTcpMonitorsIdDetails", "summary": "GET /api/tcp-monitors/{id}/details", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}/incident-history": { "get": { "operationId": "getApiTcpMonitorsIdIncidentHistory", "summary": "GET /api/tcp-monitors/{id}/incident-history", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/tcp-monitors/{id}/trigger-check": { "post": { "operationId": "postApiTcpMonitorsIdTriggerCheck", "summary": "POST /api/tcp-monitors/{id}/trigger-check", "tags": [ "Tcp Monitors" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/users": { "get": { "operationId": "getApiUsers", "summary": "List Users", "tags": [ "Users" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "users": [ { "id": "A7QJr8SOjsnTst1n9YQSYxim1GeEPht7", "email": "user004@example.test", "name": "Name 067", "firstName": "FirstName 068", "lastName": "LastName 069", "role": "admin", "isActive": true, "createdAt": "2025-12-20T17:46:49.232Z", "customerAccess": [] }, { "id": "user_1774973446122_chhxtzskqeg", "email": "user004@example.test", "name": "Name 066", "firstName": "FirstName 064", "lastName": "LastName 065", "role": "admin", "isActive": true, "createdAt": "2026-03-31T16:10:46.124Z", "customerAccess": [] } ], "limits": { "maxSeats": null, "currentSeats": 2, "remainingSeats": null } } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/users" }, "post": { "operationId": "postApiUsers", "summary": "Create User", "tags": [ "Users" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true, "user": { "id": "user_1774973446122_chhxtzskqeg", "email": "user004@example.test", "name": "Name 066", "role": "admin" } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/users", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "email": "user004@example.test", "firstName": "FirstName 064", "lastName": "LastName 065", "role": "admin", "password": "change-me-now", "customerIds": [ "00000000-0000-4000-8000-000000000046" ] } } } } } }, "/api/users/{id}": { "delete": { "operationId": "deleteApiUsersId", "summary": "Delete User", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/users/:id" }, "get": { "operationId": "getApiUsersId", "summary": "Get User", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": "user_1774973446122_chhxtzskqeg", "email": "user004@example.test", "name": "Name 066", "firstName": "FirstName 064", "lastName": "LastName 065", "role": "admin", "isActive": true, "createdAt": "2026-03-31T16:10:46.124Z", "customerAccess": [] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/users/:id" }, "patch": { "operationId": "patchApiUsersId", "summary": "Update User", "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/users/:id" } }, "/api/websites": { "get": { "operationId": "getApiWebsites", "summary": "List Websites", "tags": [ "Websites" ], "parameters": [ { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "monitoringType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "excludeMonitoringType", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "perPage", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "items": [ { "id": 2, "publicId": "00000000-0000-4000-8000-000000000015", "customerId": 6, "name": "Name 030", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "active", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:42:35.026Z", "customer": { "id": 6, "publicId": "00000000-0000-4000-8000-000000000023", "organizationId": 4, "name": "Name 027", "email": "user008@example.test", "notificationPhoneNumber": null, "notificationEmail": null, "packageId": 7, "packageType": "fullservice", "status": "active", "allowedCheckCountryCodes": null, "cancellationDate": null, "cancelledAt": null, "companyName": null, "street": null, "postalCode": null, "city": null, "country": null, "vatId": null, "mollieCustomerId": null, "mollieSubscriptionId": null, "customPricing": null, "alertConsecutiveChecks": 1, "alertLocationThreshold": "1.0", "alertLocationThresholdCount": 2, "alertReminderInterval": 60, "dnsblReminderInterval": null, "sslExpiryReminderInterval": null, "customFields": {}, "monthlyReportsEnabled": true, "notificationChannels": null, "notificationTargets": null, "notificationRules": null, "smsUsageCurrentMonth": 0, "createdAt": "2026-03-18T07:57:21.664Z", "updatedAt": "2026-03-18T07:57:36.415Z" } } ], "total": 1, "page": 1, "perPage": 50 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites" }, "post": { "operationId": "postApiWebsites", "summary": "Create Website", "tags": [ "Websites" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 2, "publicId": "00000000-0000-4000-8000-000000000015", "customerId": 6, "name": "Name 030", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "active", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": null, "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:42:35.026Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/websites", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerId": "00000000-0000-4000-8000-000000000001", "name": "My Website", "url": "https://example.com", "monitoringType": "combined", "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "basicAuthPassword": null, "authorizationHeader": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": false, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": false, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "minPageSize": null, "maxPageSize": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "customHeaders": null, "requestBody": null, "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "mtlsClientCert": null, "mtlsClientKey": null } } } } } }, "/api/websites/summary": { "post": { "operationId": "postApiWebsitesSummary", "summary": "Get Websites Summary (Batch)", "tags": [ "Websites" ], "responses": { "200": { "description": "Successful response" }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/websites/summary" } }, "/api/websites/{id}": { "delete": { "operationId": "deleteApiWebsitesId", "summary": "Delete Website", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "DELETE /api/websites/:websitePublicId" }, "get": { "operationId": "getApiWebsitesId", "summary": "Get Website", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 144, "publicId": "00000000-0000-4000-8000-000000000014", "customerId": 53, "name": "Name 045", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "active", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:42:35.026Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId" }, "patch": { "operationId": "patchApiWebsitesId", "summary": "Change Website Status", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "id": 2, "publicId": "00000000-0000-4000-8000-000000000015", "customerId": 6, "name": "Name 071", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "authorizationHeaderEncrypted": null, "basicAuthUsername": null, "basicAuthPasswordEncrypted": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "status": "inactive", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:44:02.666Z" } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/websites/:websitePublicId", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "status": "paused" } } } } } }, "/api/websites/{id}/alert-history": { "get": { "operationId": "getApiWebsitesIdAlertHistory", "summary": "Get Alert History", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "alerts": [], "total": 0 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/alert-history" } }, "/api/websites/{id}/check-config": { "patch": { "operationId": "patchApiWebsitesIdCheckConfig", "summary": "Update Check Settings", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "success": true } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "PATCH /api/websites/:websiteId/check-config", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" }, "example": { "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": false, "checkResponseTimeEnabled": true, "checkKeywordEnabled": false, "checkDomainExpiryEnabled": false, "minPageSize": 1024, "maxPageSize": 512000 } } } } } }, "/api/websites/{id}/check-history": { "get": { "operationId": "getApiWebsitesIdCheckHistory", "summary": "Get Check History", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "checkType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "data": [ { "id": "00000000-0000-4000-8000-000000000036", "status": "success", "errorMessage": null, "warningMessage": null, "timingDns": 1, "diagnostics": { "https_redirect_check": { "success": true, "finalUrl": "https://uptimeify.io/", "sourceUrl": "http://uptimeify.io/", "hstsPresent": true, "canonicalUrl": null, "canonicalHttps": null, "redirectLocation": "https://uptimeify.io/", "redirectStatusCode": 301 } }, "checkedAt": "2026-04-01T20:33:00.006Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" }, { "id": "00000000-0000-4000-8000-000000000038", "status": "success", "errorMessage": null, "warningMessage": null, "timingDns": 1, "diagnostics": { "https_redirect_check": { "success": true, "finalUrl": "https://uptimeify.io/", "sourceUrl": "http://uptimeify.io/", "hstsPresent": true, "canonicalUrl": null, "canonicalHttps": null, "redirectLocation": "https://uptimeify.io/", "redirectStatusCode": 301 } }, "checkedAt": "2026-04-01T20:32:30.928Z", "locationId": 8, "locationName": "Name 028", "locationCode": "ch-zrh" } ] } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/check-history" } }, "/api/websites/{id}/details": { "get": { "operationId": "getApiWebsitesIdDetails", "summary": "Get Website Details", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "Response", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "websiteId": 2, "website": { "id": 2, "publicId": "00000000-0000-4000-8000-000000000015", "customerId": 6, "name": "Name 030", "url": "https://uptimeify.io/", "monitoringType": "combined", "dnsConfig": {}, "checkInterval": 5, "timeoutSeconds": 30, "expectedStatusCodes": "200,301,302", "searchTerm": null, "playwrightScript": null, "playwrightEnv": {}, "playwrightDevice": null, "playwrightViewportWidth": null, "playwrightViewportHeight": null, "playwrightRetries": 0, "playwrightTimeoutMs": 30000, "allowedCheckCountryCodes": null, "customFields": {}, "authMode": "none", "basicAuthUsername": null, "checkSslEnabled": true, "checkHttpsRedirectEnabled": true, "checkStatusEnabled": true, "checkSizeEnabled": true, "checkResponseTimeEnabled": true, "checkKeywordEnabled": true, "checkDomainExpiryEnabled": true, "checkExpectedResponseEnabled": false, "expectedResponseMatchType": "contains", "expectedResponseValue": null, "expectedResponseJsonPath": null, "sslNoticeDays": 7, "sslErrorDays": 0, "domainExpiryNoticeDays": 30, "domainExpiryErrorDays": 7, "minPageSize": null, "maxPageSize": null, "heartbeatToken": null, "heartbeatGracePeriodMinutes": null, "httpMethod": "GET", "followRedirects": true, "cookieHandling": "none", "mtlsEnabled": false, "status": "active", "escalationDisabled": false, "escalationDisabledReason": null, "escalationDisabledAt": null, "escalationReactivationAt": null, "notificationPhoneNumber": null, "notificationEmail": null, "lastCheckedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:42:35.026Z", "updatedAt": "2026-03-31T17:42:35.026Z" }, "latestCheck": { "id": "00000000-0000-4000-8000-0000000000bd", "websiteId": 2, "locationId": 8, "checkType": "combined", "status": "success", "responseTimeMs": 169, "statusCode": 200, "sslValid": true, "sslExpiresAt": "2026-06-02T09:10:35.000Z", "domainExpiresAt": null, "domainRegistrar": null, "contentFound": null, "contentSize": 29834, "httpsRedirect": true, "ipv6": null, "errorMessage": null, "warningMessage": null, "timingDns": 1, "timingTcp": 2, "timingTls": 7, "timingTtfb": 157, "timingTransfer": 1, "diagnostics": { "https_redirect_check": { "success": true, "finalUrl": "https://uptimeify.io/", "sourceUrl": "http://uptimeify.io/", "hstsPresent": false, "canonicalUrl": null, "canonicalHttps": null, "redirectLocation": "https://uptimeify.io/", "redirectStatusCode": 301 } }, "screenshot": null, "checkedAt": "2026-03-31T17:43:00.005Z", "createdAt": "2026-03-31T17:43:00.486Z" }, "uptimeStats": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 283, "monthAvgResponse": 283, "yearAvgResponse": 283 }, "uptimeStatsMeta": { "day": { "window": "24h", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 2, "checksFailed": 0 }, "month": { "window": "30d", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 2, "checksFailed": 0 }, "year": { "window": "YTD", "downtimeMinutes": 0, "incidents": 0, "checksTotal": 2, "checksFailed": 0 } }, "monitoringData": { "responseTimeData": [ { "timestamp": "2026-03-31 17:40:00+00", "responseTime": 283, "status": "success", "success": true, "timingDns": 11, "timingTcp": 2, "timingTls": 7, "timingTtfb": 261, "timingTransfer": 1 } ], "statusData": [ { "date": "01.01.", "status": "empty" }, { "date": "02.01.", "status": "empty" }, { "date": "03.01.", "status": "empty" }, { "date": "04.01.", "status": "empty" }, { "date": "05.01.", "status": "empty" }, { "date": "06.01.", "status": "empty" }, { "date": "07.01.", "status": "empty" }, { "date": "08.01.", "status": "empty" }, { "date": "09.01.", "status": "empty" }, { "date": "10.01.", "status": "empty" }, { "date": "11.01.", "status": "empty" }, { "date": "12.01.", "status": "empty" }, { "date": "13.01.", "status": "empty" }, { "date": "14.01.", "status": "empty" }, { "date": "15.01.", "status": "empty" }, { "date": "16.01.", "status": "empty" }, { "date": "17.01.", "status": "empty" }, { "date": "18.01.", "status": "empty" }, { "date": "19.01.", "status": "empty" }, { "date": "20.01.", "status": "empty" }, { "date": "21.01.", "status": "empty" }, { "date": "22.01.", "status": "empty" }, { "date": "23.01.", "status": "empty" }, { "date": "24.01.", "status": "empty" }, { "date": "25.01.", "status": "empty" }, { "date": "26.01.", "status": "empty" }, { "date": "27.01.", "status": "empty" }, { "date": "28.01.", "status": "empty" }, { "date": "29.01.", "status": "empty" }, { "date": "30.01.", "status": "empty" }, { "date": "31.01.", "status": "empty" }, { "date": "01.02.", "status": "empty" }, { "date": "02.02.", "status": "empty" }, { "date": "03.02.", "status": "empty" }, { "date": "04.02.", "status": "empty" }, { "date": "05.02.", "status": "empty" }, { "date": "06.02.", "status": "empty" }, { "date": "07.02.", "status": "empty" }, { "date": "08.02.", "status": "empty" }, { "date": "09.02.", "status": "empty" }, { "date": "10.02.", "status": "empty" }, { "date": "11.02.", "status": "empty" }, { "date": "12.02.", "status": "empty" }, { "date": "13.02.", "status": "empty" }, { "date": "14.02.", "status": "empty" }, { "date": "15.02.", "status": "empty" }, { "date": "16.02.", "status": "empty" }, { "date": "17.02.", "status": "empty" }, { "date": "18.02.", "status": "empty" }, { "date": "19.02.", "status": "empty" }, { "date": "20.02.", "status": "empty" }, { "date": "21.02.", "status": "empty" }, { "date": "22.02.", "status": "empty" }, { "date": "23.02.", "status": "empty" }, { "date": "24.02.", "status": "empty" }, { "date": "25.02.", "status": "empty" }, { "date": "26.02.", "status": "empty" }, { "date": "27.02.", "status": "empty" }, { "date": "28.02.", "status": "empty" }, { "date": "01.03.", "status": "empty" }, { "date": "02.03.", "status": "empty" }, { "date": "03.03.", "status": "empty" }, { "date": "04.03.", "status": "empty" }, { "date": "05.03.", "status": "empty" }, { "date": "06.03.", "status": "empty" }, { "date": "07.03.", "status": "empty" }, { "date": "08.03.", "status": "empty" }, { "date": "09.03.", "status": "empty" }, { "date": "10.03.", "status": "empty" }, { "date": "11.03.", "status": "empty" }, { "date": "12.03.", "status": "empty" }, { "date": "13.03.", "status": "empty" }, { "date": "14.03.", "status": "empty" }, { "date": "15.03.", "status": "empty" }, { "date": "16.03.", "status": "empty" }, { "date": "17.03.", "status": "empty" }, { "date": "18.03.", "status": "empty" }, { "date": "19.03.", "status": "empty" }, { "date": "20.03.", "status": "empty" }, { "date": "21.03.", "status": "empty" }, { "date": "22.03.", "status": "empty" }, { "date": "23.03.", "status": "empty" }, { "date": "24.03.", "status": "empty" }, { "date": "25.03.", "status": "empty" }, { "date": "26.03.", "status": "empty" }, { "date": "27.03.", "status": "empty" }, { "date": "28.03.", "status": "empty" }, { "date": "29.03.", "status": "empty" }, { "date": "30.03.", "status": "empty" }, { "date": "31.03.", "status": "online" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 2, "successfulChecks": 2 }, "incidents": { "history": [], "total": 0, "ongoing": 0, "totalDowntime": "0s" }, "alerts": { "history": [], "total": 0, "notificationContext": { "customerEmail": "user008@example.test", "orgDefaultEmail": null, "orgDefaultPhoneNumber": null, "notificationTargets": { "sms": "organization", "email": "user010@example.test", "webhook": "organization", "integrations": "customer" } } }, "testResultLog": [ { "checkType": "combined", "status": "success", "success": true, "statusCode": 200, "errorMessage": null, "checkedAt": "2026-03-31T17:43:00.005Z", "responseTimeMs": 169, "location": { "name": "Name 028", "code": "ch-zrh" } }, { "checkType": "combined", "status": "success", "success": true, "statusCode": 200, "errorMessage": null, "checkedAt": "2026-03-31T17:42:35.049Z", "responseTimeMs": 397, "location": { "name": "Name 028", "code": "ch-zrh" } } ], "maintenance": { "inMaintenance": false, "activeWindows": [], "allWindows": [] } } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/details" } }, "/api/websites/{id}/incident-history": { "get": { "operationId": "getApiWebsitesIdIncidentHistory", "summary": "Get Incident History", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "incidents": [], "total": 0 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/incident-history" } }, "/api/websites/{id}/monitoring-data": { "get": { "operationId": "getApiWebsitesIdMonitoringData", "summary": "Get Monitoring Data", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "maxPoints", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "responseTimeData": [ { "timestamp": "2026-03-31 17:52:00+00", "responseTime": 76, "status": "success", "success": true, "timingDns": 17, "timingTcp": 0, "timingTls": 7, "timingTtfb": 50, "timingTransfer": 1 }, { "timestamp": "2026-03-31 17:51:00+00", "responseTime": 112, "status": "success", "success": true, "timingDns": 19, "timingTcp": 1, "timingTls": 6, "timingTtfb": 85, "timingTransfer": 0 } ], "statusData": [ { "date": "31.03.", "status": "online" } ], "uptimePercentage": "100.00", "checkSuccessRatePercentage": "100.00", "totalChecks": 2, "successfulChecks": 2 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/monitoring-data?range=day|week|month|year" } }, "/api/websites/{id}/report.pdf": { "get": { "operationId": "getApiWebsitesIdReportPdf", "summary": "Download PDF Report", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/report.pdf" } }, "/api/websites/{id}/trigger-check": { "post": { "operationId": "postApiWebsitesIdTriggerCheck", "summary": "Trigger Website Check", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response" }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "POST /api/websites/:websitePublicId/trigger-check" } }, "/api/websites/{id}/uptime-stats": { "get": { "operationId": "getApiWebsitesIdUptimeStats", "summary": "Get Uptime Stats", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" }, "example": { "day": "100.00", "month": "100.00", "year": "100.00", "dayAvgResponse": 63, "monthAvgResponse": 63, "yearAvgResponse": 63 } } } }, "400": { "description": "Invalid or missing parameters.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid or expired API token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such resource, or not visible to this token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "description": "GET /api/websites/:websitePublicId/uptime-stats" } } } }