{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/app.hostrepute.com" } ], "info": { "name": "HostRepute API Documentation", "_postman_id": "5075f667-e2b6-4a04-9068-40ad162e0ecf", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Alert Destinations", "description": "\nAPIs for managing alert destinations", "item": [ { "name": "List all alert destinations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alerts", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/alerts?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22}" }, "description": "Get a paginated list of all alert destinations belonging to the authenticated team." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uuid\":\"019e3978-e878-73af-a8e9-4b676c98f473\",\"type\":\"email\",\"frequency\":\"once_on_listed_delisted\",\"is_active\":true,\"last_sent_at\":null,\"created_at\":\"2026-05-18T05:04:45.000000Z\",\"updated_at\":\"2026-05-18T05:04:45.000000Z\"},{\"uuid\":\"019e3978-ea36-732f-9267-48112eb6de94\",\"type\":\"pagerduty\",\"frequency\":\"once_per_check_while_listed\",\"is_active\":true,\"last_sent_at\":null,\"created_at\":\"2026-05-18T05:04:46.000000Z\",\"updated_at\":\"2026-05-18T05:04:46.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create an alert destination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alerts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alerts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"email\",\"settings\":{\"recipient\":\"admin@example.com\",\"email\":\"gbailey@example.net\",\"slack_webhook_url\":\"http:\\\/\\\/rempel.com\\\/sunt-nihil-accusantium-harum-mollitia\",\"telegram_chat_id\":\"k\",\"discord_webhook_url\":\"http:\\\/\\\/www.schuster.biz\\\/perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem-nostrum-qui\",\"pagerduty_routing_key\":\"v\",\"pushover_user_key\":\"q\",\"webhook_url\":\"http:\\\/\\\/www.keebler.com\\\/modi-ipsum-nostrum-omnis-autem-et\",\"webhook_secret\":\"l\"},\"frequency\":\"daily\",\"is_active\":true,\"alert_group_uuids\":[\"550e8400-e29b-41d4-a716-446655440000\"]}" }, "description": "Create a new alert destination for the authenticated team." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3978-ebb3-72d5-95d4-d740ce2fb617\",\"type\":\"pagerduty\",\"frequency\":\"every_check\",\"is_active\":true,\"last_sent_at\":null,\"created_at\":\"2026-05-18T05:04:46.000000Z\",\"updated_at\":\"2026-05-18T05:04:46.000000Z\"}}", "name": "" } ] }, { "name": "Get an alert destination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alerts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alerts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "alert", "key": "alert", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the alert destination." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific alert destination." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-ed88-71b5-bedf-9d04e794768b\",\"type\":\"email\",\"frequency\":\"once_on_listed_delisted\",\"is_active\":true,\"last_sent_at\":null,\"created_at\":\"2026-05-18T05:04:46.000000Z\",\"updated_at\":\"2026-05-18T05:04:46.000000Z\"}}", "name": "" } ] }, { "name": "Update an alert destination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alerts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alerts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "alert", "key": "alert", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the alert destination." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"type\":\"email\",\"settings\":{\"recipient\":\"admin@example.com\",\"email\":\"gbailey@example.net\",\"slack_webhook_url\":\"http:\\\/\\\/rempel.com\\\/sunt-nihil-accusantium-harum-mollitia\",\"telegram_chat_id\":\"k\",\"discord_webhook_url\":\"http:\\\/\\\/www.schuster.biz\\\/perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem-nostrum-qui\",\"pagerduty_routing_key\":\"v\",\"pushover_user_key\":\"q\",\"webhook_url\":\"http:\\\/\\\/www.keebler.com\\\/modi-ipsum-nostrum-omnis-autem-et\",\"webhook_secret\":\"l\"},\"frequency\":\"daily\",\"is_active\":true,\"alert_group_uuids\":[\"550e8400-e29b-41d4-a716-446655440000\"]}" }, "description": "Update an existing alert destination." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-ef0a-7092-97d2-a37b13a40fcb\",\"type\":\"pagerduty\",\"frequency\":\"every_check\",\"is_active\":true,\"last_sent_at\":null,\"created_at\":\"2026-05-18T05:04:47.000000Z\",\"updated_at\":\"2026-05-18T05:04:47.000000Z\"}}", "name": "" } ] }, { "name": "Delete an alert destination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alerts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alerts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "alert", "key": "alert", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the alert destination." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing alert destination." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" } ] } ] }, { "name": "Blacklist", "description": "\nAPIs for checking hosts against blocklists", "item": [ { "name": "Initiate a blacklist check", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/blacklist\/check", "query": [], "raw": "{{baseUrl}}\/api\/v1\/blacklist\/check" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"example.com\",\"data_source_group_uuid\":\"550e8400-e29b-41d4-a716-446655440000\",\"callback_url\":\"https:\\\/\\\/example.com\\\/webhook\\\/blacklist\"}" }, "description": "Start an asynchronous blacklist check for a host. Returns a UUID that can be used\nto poll for results using the status endpoint." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3978-fb8b-7120-b8b9-49783b893a32\",\"host\":\"runte.com\",\"status\":\"pending\",\"is_completed\":false,\"callback_status\":null,\"started_at\":null,\"completed_at\":null,\"created_at\":\"2026-05-18T05:04:50.000000Z\"}}", "name": "" } ] }, { "name": "Get blacklist check status", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/blacklist\/status\/:scan_uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/blacklist\/status\/:scan_uuid", "variable": [ { "id": "scan_uuid", "key": "scan_uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "scan", "key": "scan", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the blacklist scan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get the status and results of a blacklist check. Poll this endpoint until\nthe status is 'completed' or 'failed'." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-feb8-71c0-bb7e-efb7cbde2277\",\"host\":\"bailey.com\",\"status\":\"pending\",\"is_completed\":false,\"callback_status\":null,\"started_at\":null,\"completed_at\":null,\"created_at\":\"2026-05-18T05:04:51.000000Z\"}}", "name": "" } ] } ] }, { "name": "Certificates", "description": "\nAPIs for checking certificate health and expiry.", "item": [ { "name": "Initiate a certificate check.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/certificates\/check", "query": [], "raw": "{{baseUrl}}\/api\/v1\/certificates\/check" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"example.com\",\"protocol\":\"https\",\"port\":443,\"sni\":\"example.com\",\"callback_url\":\"https:\\\/\\\/example.com\\\/webhook\\\/certificate\"}" }, "description": "Start an asynchronous certificate check. Returns a UUID that can be used\nto poll for results using the status endpoint." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3979-013e-700c-9fb5-b0f4387a7412\",\"host\":\"runte.com\",\"port\":443,\"protocol\":\"https\",\"sni\":null,\"status\":\"pending\",\"is_completed\":false,\"callback_status\":null,\"started_at\":null,\"completed_at\":null,\"created_at\":\"2026-05-18T05:04:52.000000Z\"}}", "name": "" } ] }, { "name": "Get certificate check status.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/certificates\/status\/:scan_uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/certificates\/status\/:scan_uuid", "variable": [ { "id": "scan_uuid", "key": "scan_uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "scan", "key": "scan", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the certificate scan." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Poll this endpoint until the status is 'completed' or 'failed'." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3979-02df-70d6-94bd-3331a5558b25\",\"host\":\"bailey.com\",\"port\":443,\"protocol\":\"https\",\"sni\":null,\"status\":\"pending\",\"is_completed\":false,\"callback_status\":null,\"started_at\":null,\"completed_at\":null,\"created_at\":\"2026-05-18T05:04:52.000000Z\"}}", "name": "" } ] } ] }, { "name": "Contact Groups", "description": "\nAPIs for managing contact groups", "item": [ { "name": "List all contact groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alert-groups", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/alert-groups?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22}" }, "description": "Get a paginated list of all contact groups belonging to the authenticated team." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uuid\":\"019e3978-f1cc-709e-9da7-ace316ae775e\",\"name\":\"et animi quos\",\"slug\":\"et-animi-quos\",\"timezone\":\"America\\\/Moncton\",\"schedule\":null,\"is_default\":false,\"created_at\":\"2026-05-18T05:04:48.000000Z\",\"updated_at\":\"2026-05-18T05:04:48.000000Z\"},{\"uuid\":\"019e3978-f385-72b0-86f3-b3a86b9a2a5b\",\"name\":\"et et modi\",\"slug\":\"et-et-modi\",\"timezone\":\"Europe\\\/Gibraltar\",\"schedule\":null,\"is_default\":false,\"created_at\":\"2026-05-18T05:04:48.000000Z\",\"updated_at\":\"2026-05-18T05:04:48.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create a contact group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alert-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alert-groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Critical Contacts\",\"slug\":\"critical-contacts\",\"timezone\":\"UTC\",\"schedule\":{\"days\":[\"monday\",\"tuesday\"],\"hours\":[9,17]},\"is_default\":false,\"alert_uuids\":[\"550e8400-e29b-41d4-a716-446655440000\"]}" }, "description": "Create a new contact group for the authenticated team." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3978-f50c-7240-847d-a422d1a921f3\",\"name\":\"eius et animi\",\"slug\":\"eius-et-animi\",\"timezone\":\"America\\\/La_Paz\",\"schedule\":null,\"is_default\":false,\"created_at\":\"2026-05-18T05:04:48.000000Z\",\"updated_at\":\"2026-05-18T05:04:48.000000Z\"}}", "name": "" } ] }, { "name": "Get a contact group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alert-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alert-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78e3-7360-a0e8-11f64fd1e4f4", "description": "" }, { "id": "alert_group", "key": "alert_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the contact group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific contact group." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-f6a7-72cb-ab84-5a0cc19d1277\",\"name\":\"qui commodi incidunt\",\"slug\":\"qui-commodi-incidunt\",\"timezone\":\"America\\\/Lower_Princes\",\"schedule\":null,\"is_default\":false,\"created_at\":\"2026-05-18T05:04:49.000000Z\",\"updated_at\":\"2026-05-18T05:04:49.000000Z\"}}", "name": "" } ] }, { "name": "Update a contact group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alert-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alert-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78e3-7360-a0e8-11f64fd1e4f4", "description": "" }, { "id": "alert_group", "key": "alert_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the contact group." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Critical Contacts\",\"timezone\":\"UTC\",\"schedule\":{\"days\":[\"monday\",\"tuesday\"],\"hours\":[9,17]},\"is_default\":false,\"alert_uuids\":[\"550e8400-e29b-41d4-a716-446655440000\"],\"slug\":\"critical-contacts\"}" }, "description": "Update an existing contact group." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-f857-706c-a699-c2cfda43e02a\",\"name\":\"eius et animi\",\"slug\":\"eius-et-animi\",\"timezone\":\"America\\\/La_Paz\",\"schedule\":null,\"is_default\":false,\"created_at\":\"2026-05-18T05:04:49.000000Z\",\"updated_at\":\"2026-05-18T05:04:49.000000Z\"}}", "name": "" } ] }, { "name": "Delete a contact group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/alert-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/alert-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78e3-7360-a0e8-11f64fd1e4f4", "description": "" }, { "id": "alert_group", "key": "alert_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the contact group." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing contact group." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" } ] } ] }, { "name": "Data Sources", "description": "\nAPIs for viewing available data sources (blacklist sources)", "item": [ { "name": "List all data sources", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-sources", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/data-sources?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22}" }, "description": "Get a paginated list of all available data sources." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":164,\"host\":\"bailey.com\",\"name\":\"Rempel, Gulgowski and O'Kon Blacklist\",\"description\":\"Nihil accusantium harum mollitia modi deserunt.\",\"website\":\"http:\\\/\\\/www.dubuque.net\\\/quo-omnis-nostrum-aut-adipisci\",\"provider\":\"cbl\",\"is_active\":true,\"created_at\":\"2026-05-18T05:04:42.000000Z\",\"updated_at\":\"2026-05-18T05:04:42.000000Z\"},{\"id\":165,\"host\":\"cronin.com\",\"name\":\"Leuschke Inc Blacklist\",\"description\":\"Et et modi ipsum nostrum.\",\"website\":\"http:\\\/\\\/koch.biz\\\/aut-dolores-enim-non-facere-tempora-ex-voluptatem.html\",\"provider\":\"facebook\",\"is_active\":true,\"created_at\":\"2026-05-18T05:04:42.000000Z\",\"updated_at\":\"2026-05-18T05:04:42.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Get a data source", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-sources\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/data-sources\/:id", "variable": [ { "id": "id", "key": "id", "value": "100", "description": "The ID of the data source." }, { "id": "data_source", "key": "data_source", "value": "1", "description": "The ID of the data source." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific data source." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":166,\"host\":\"raynor.org\",\"name\":\"Haag and Sons Blacklist\",\"description\":\"Distinctio eum doloremque id aut libero aliquam veniam corporis.\",\"website\":\"http:\\\/\\\/www.schaden.com\\\/odit-quia-officia-est-dignissimos-neque-blanditiis-odio.html\",\"provider\":\"0spam\",\"is_active\":true,\"created_at\":\"2026-05-18T05:04:42.000000Z\",\"updated_at\":\"2026-05-18T05:04:42.000000Z\"}}", "name": "" } ] } ] }, { "name": "Endpoints", "description": "", "item": [ { "name": "Run an email deliverability DNS check.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deliverability\/check", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deliverability\/check" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"host\":\"b\",\"data_source_group_uuid\":\"a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"checks\":[\"architecto\"]}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] }, { "name": "Get an email deliverability DNS check result.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/deliverability\/status\/:check_uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/deliverability\/status\/:check_uuid", "variable": [ { "id": "check_uuid", "key": "check_uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/metrics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/metrics", "query": [], "raw": "{{baseUrl}}\/api\/v1\/metrics" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/certificate-agent\/tasks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/certificate-agent\/tasks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/certificate-agent\/tasks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"limit\":1}" }, "description": "", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "www-authenticate", "value": "Bearer" }, { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "x-ratelimit-limit", "value": "60" }, { "key": "x-ratelimit-remaining", "value": "59" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\n \"message\": \"Missing certificate agent token.\"\n}", "name": "" } ] }, { "name": "POST api\/v1\/certificate-agent\/tasks\/{monitor_uuid}\/result", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/certificate-agent\/tasks\/:monitor_uuid\/result", "query": [], "raw": "{{baseUrl}}\/api\/v1\/certificate-agent\/tasks\/:monitor_uuid\/result", "variable": [ { "id": "monitor_uuid", "key": "monitor_uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"status\":\"pending\",\"host\":\"b\",\"port\":22,\"protocol\":\"starttls_ldap\",\"sni\":\"g\",\"checked_ip\":\"1.102.226.211\",\"resolved_ips\":[\"1.102.226.211\"],\"issuer\":\"g\",\"subject\":\"z\",\"common_name\":\"m\",\"sans\":[\"i\"],\"serial_number\":\"y\",\"fingerprint_sha256\":\"v\",\"signature_algorithm\":\"d\",\"valid_from\":\"2026-05-18T05:04:52\",\"expires_at\":\"2026-05-18T05:04:52\",\"days_remaining\":16,\"chain_valid\":false,\"hostname_valid\":true,\"caa_valid\":true,\"algorithm_secure\":true,\"revocation_status\":\"n\",\"events\":[\"connection_failed\"],\"error_message\":\"g\",\"checked_at\":\"2026-05-18T05:04:52\"}" }, "description": "", "auth": { "type": "noauth" } }, "response": [] } ] }, { "name": "Hosts", "description": "\nAPIs for managing hosts", "item": [ { "name": "List all hosts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/hosts?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22}" }, "description": "Get a paginated list of all hosts belonging to the authenticated team." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uuid\":\"019e3978-ce80-7191-8b1c-c1ee53ddcd8d\",\"name\":\"et animi quos\",\"host\":\"rempel.com\",\"blocklisted_at\":null,\"created_at\":\"2026-05-18T05:04:39.000000Z\",\"updated_at\":\"2026-05-18T05:04:39.000000Z\"},{\"uuid\":\"019e3978-d180-7292-b782-2e24d7269d5a\",\"name\":\"non facere tempora\",\"host\":\"feeney.com\",\"blocklisted_at\":null,\"created_at\":\"2026-05-18T05:04:39.000000Z\",\"updated_at\":\"2026-05-18T05:04:39.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create a host", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data_source_group_uuid\":\"550e8400-e29b-41d4-a716-446655440000\",\"name\":\"My Web Server\",\"host\":\"example.com\"}" }, "description": "Create a new host for the authenticated team." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3978-d50e-70b9-8a82-6385eb548a69\",\"name\":\"quos velit et\",\"host\":\"okon.com\",\"blocklisted_at\":null,\"created_at\":\"2026-05-18T05:04:40.000000Z\",\"updated_at\":\"2026-05-18T05:04:40.000000Z\"}}", "name": "" } ] }, { "name": "Get a host", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "host", "key": "host", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the host." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific host." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-da6d-71ec-aeea-3f0d685b439c\",\"name\":\"et animi quos\",\"host\":\"rempel.com\",\"blocklisted_at\":null,\"created_at\":\"2026-05-18T05:04:42.000000Z\",\"updated_at\":\"2026-05-18T05:04:42.000000Z\"}}", "name": "" } ] }, { "name": "Update a host", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "host", "key": "host", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the host." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"data_source_group_uuid\":\"550e8400-e29b-41d4-a716-446655440000\",\"name\":\"My Web Server\",\"host\":\"example.com\"}" }, "description": "Update an existing host." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-dd8e-70b1-9d95-f8319ba10ec5\",\"name\":\"quos velit et\",\"host\":\"okon.com\",\"blocklisted_at\":null,\"created_at\":\"2026-05-18T05:04:42.000000Z\",\"updated_at\":\"2026-05-18T05:04:42.000000Z\"}}", "name": "" } ] }, { "name": "Delete a host", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/hosts\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/hosts\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "6ff8f7f6-1eb3-3525-be4a-3932c805afed", "description": "" }, { "id": "host", "key": "host", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the host." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing host." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" } ] } ] }, { "name": "Monitoring Profiles", "description": "\nAPIs for managing monitoring profiles", "item": [ { "name": "List all monitoring profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-source-groups", "query": [ { "key": "page", "value": "1", "description": "The page number.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/data-source-groups?page=1&per_page=15" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"page\":16,\"per_page\":22}" }, "description": "Get a paginated list of all monitoring profiles belonging to the authenticated team." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"uuid\":\"019e3978-df47-71a3-bd1e-f0bf4395ba9e\",\"name\":\"et animi quos\",\"slug\":\"et-animi-quos\",\"description\":null,\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":null,\"created_at\":\"2026-05-18T05:04:43.000000Z\",\"updated_at\":\"2026-05-18T05:04:43.000000Z\"},{\"uuid\":\"019e3978-e0cb-7109-abfb-93a0c39cee2e\",\"name\":\"provident perspiciatis quo\",\"slug\":\"provident-perspiciatis-quo\",\"description\":null,\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":null,\"created_at\":\"2026-05-18T05:04:43.000000Z\",\"updated_at\":\"2026-05-18T05:04:43.000000Z\"}],\"links\":{\"first\":\"\\\/?page=1\",\"last\":\"\\\/?page=1\",\"prev\":null,\"next\":null},\"meta\":{\"current_page\":1,\"from\":1,\"last_page\":1,\"links\":[{\"url\":null,\"label\":\"« Previous\",\"page\":null,\"active\":false},{\"url\":\"\\\/?page=1\",\"label\":\"1\",\"page\":1,\"active\":true},{\"url\":null,\"label\":\"Next »\",\"page\":null,\"active\":false}],\"path\":\"\\\/\",\"per_page\":15,\"to\":2,\"total\":2}}", "name": "" } ] }, { "name": "Create a monitoring profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-source-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/data-source-groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Production Servers\",\"slug\":\"production-servers\",\"description\":\"All production server hosts\",\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":[\"architecto\"]}" }, "description": "Create a new monitoring profile for the authenticated team." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"uuid\":\"019e3978-e368-709e-9b56-1b8a66495f1a\",\"name\":\"eius et animi\",\"slug\":\"eius-et-animi\",\"description\":\"Et fugiat sunt nihil accusantium.\",\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":null,\"created_at\":\"2026-05-18T05:04:44.000000Z\",\"updated_at\":\"2026-05-18T05:04:44.000000Z\"}}", "name": "" } ] }, { "name": "Get a monitoring profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-source-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/data-source-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78db-734e-80d0-685c4b095b15", "description": "" }, { "id": "data_source_group", "key": "data_source_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the monitoring profile." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get detailed information about a specific monitoring profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-e51d-7155-8555-6ea3a76f4911\",\"name\":\"aut adipisci quidem\",\"slug\":\"aut-adipisci-quidem\",\"description\":\"Commodi incidunt iure odit.\",\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":null,\"created_at\":\"2026-05-18T05:04:44.000000Z\",\"updated_at\":\"2026-05-18T05:04:44.000000Z\"}}", "name": "" } ] }, { "name": "Update a monitoring profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-source-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/data-source-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78db-734e-80d0-685c4b095b15", "description": "" }, { "id": "data_source_group", "key": "data_source_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the monitoring profile." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Production Servers\",\"description\":\"All production server hosts\",\"is_default\":false,\"deliverability_checks_enabled\":true,\"deliverability_checks\":[\"architecto\"],\"slug\":\"production-servers\"}" }, "description": "Update an existing monitoring profile." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"uuid\":\"019e3978-e6ea-701a-8dbd-bee503f60c33\",\"name\":\"eius et animi\",\"slug\":\"eius-et-animi\",\"description\":\"Et fugiat sunt nihil accusantium.\",\"is_default\":false,\"deliverability_checks_enabled\":false,\"deliverability_checks\":null,\"created_at\":\"2026-05-18T05:04:45.000000Z\",\"updated_at\":\"2026-05-18T05:04:45.000000Z\"}}", "name": "" } ] }, { "name": "Delete a monitoring profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/data-source-groups\/:uuid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/data-source-groups\/:uuid", "variable": [ { "id": "uuid", "key": "uuid", "value": "019e0cb0-78db-734e-80d0-685c4b095b15", "description": "" }, { "id": "data_source_group", "key": "data_source_group", "value": "550e8400-e29b-41d4-a716-446655440000", "description": "The UUID of the monitoring profile." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Delete an existing monitoring profile." }, "response": [ { "header": [], "code": 204, "body": "{}", "name": "Success" } ] } ] } ], "auth": { "type": "noauth" } }