{ "opencollection": "1.0.0", "info": { "name": "Keep API", "version": "0.24.5" }, "items": [ { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "Root", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/" }, "docs": "App desctiption and version." } ] }, { "info": { "name": "providers", "type": "folder" }, "items": [ { "info": { "name": "Get Providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Providers" }, { "info": { "name": "Get Installed Providers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/export", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "export all installed providers" }, { "info": { "name": "Get Alerts Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/:provider_type/:provider_id/configured-alerts", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alerts configuration from a provider" }, { "info": { "name": "Get Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/:provider_type/:provider_id/logs", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get logs from a provider" }, { "info": { "name": "Get Alerts Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/:provider_type/schema", "params": [ { "name": "provider_type", "value": "", "type": "path" } ] }, "docs": "Get the provider's API schema used to push alerts configuration" }, { "info": { "name": "Get Alert Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/:provider_type/:provider_id/alerts/count", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" }, { "name": "ever", "value": "", "type": "query" }, { "name": "start_time", "value": "", "type": "query" }, { "name": "end_time", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get number of alerts a specific provider has received (in a specific time time period or ever)" }, { "info": { "name": "Add Alert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/:provider_type/:provider_id/alerts", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" }, { "name": "alert_id", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Push new alerts to the provider" }, { "info": { "name": "Test Provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Test a provider's alert retrieval" }, { "info": { "name": "Delete Provider", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/providers/:provider_type/:provider_id", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete Provider" }, { "info": { "name": "Validate Provider Scopes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/:provider_id/scopes", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Validate provider scopes" }, { "info": { "name": "Update Provider", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/providers/:provider_id", "params": [ { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update provider" }, { "info": { "name": "Install Provider", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/install", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Install Provider" }, { "info": { "name": "Install Provider Oauth2", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/install/oauth2/:provider_type", "params": [ { "name": "provider_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Install Provider Oauth2" }, { "info": { "name": "Invoke Provider Method", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/:provider_id/invoke/:method", "params": [ { "name": "provider_id", "value": "", "type": "path" }, { "name": "method", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Invoke provider special method" }, { "info": { "name": "Install Provider Webhook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/providers/install/webhook/:provider_type/:provider_id", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Install Provider Webhook" }, { "info": { "name": "Get Webhook Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/providers/:provider_type/webhook", "params": [ { "name": "provider_type", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Webhook Settings" } ] }, { "info": { "name": "actions", "type": "folder" }, "items": [ { "info": { "name": "Get Actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/actions", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all actions" }, { "info": { "name": "Create Actions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/actions", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create new actions by uploading a file" }, { "info": { "name": "Put Action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/actions/:action_id", "params": [ { "name": "action_id", "value": "", "type": "path" } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update an action" }, { "info": { "name": "Delete Action", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/actions/:action_id", "params": [ { "name": "action_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete an action" } ] }, { "info": { "name": "healthcheck", "type": "folder" }, "items": [ { "info": { "name": "Healthcheck", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/healthcheck" }, "docs": "simple healthcheck endpoint" } ] }, { "info": { "name": "alerts", "type": "folder" }, "items": [ { "info": { "name": "Get All Alerts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts", "params": [ { "name": "limit", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get last alerts occurrence" }, { "info": { "name": "Delete Alert", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/alerts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete alert by finerprint and last received time" }, { "info": { "name": "Get Alert History", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/:fingerprint/history", "params": [ { "name": "fingerprint", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alert history" }, { "info": { "name": "Assign Alert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/:fingerprint/assign/:last_received", "params": [ { "name": "fingerprint", "value": "", "type": "path" }, { "name": "last_received", "value": "", "type": "path" }, { "name": "unassign", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Assign alert to user" }, { "info": { "name": "Receive Generic Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/event", "params": [ { "name": "fingerprint", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Receive a generic alert event" }, { "info": { "name": "Webhook Challenge", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/event/netdata" }, "docs": "Helper function to complete Netdata webhook challenge" }, { "info": { "name": "Receive Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/event/:provider_type", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "query" }, { "name": "fingerprint", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Receive an alert event from a provider" }, { "info": { "name": "Get Alert", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/:fingerprint", "params": [ { "name": "fingerprint", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alert by fingerprint" }, { "info": { "name": "Enrich Alert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/enrich", "params": [ { "name": "dispose_on_new_alert", "value": "", "type": "query", "description": "Dispose on new alert" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Enrich an alert" }, { "info": { "name": "Unenrich Alert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/unenrich", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Un-Enrich an alert" }, { "info": { "name": "Search Alerts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/search", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Search alerts" }, { "info": { "name": "Get Multiple Fingerprint Alert Audit", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/alerts/audit", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alert timeline audit trail for multiple fingerprints" }, { "info": { "name": "Get Alert Audit", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/:fingerprint/audit", "params": [ { "name": "fingerprint", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alert timeline audit trail" }, { "info": { "name": "Get Alert Quality", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/alerts/quality/metrics", "params": [ { "name": "fields", "value": "", "type": "query" }, { "name": "time_stamp", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get alert quality" } ] }, { "info": { "name": "incidents", "type": "folder" }, "items": [ { "info": { "name": "Get All Incidents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents", "params": [ { "name": "confirmed", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sorting", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "severity", "value": "", "type": "query" }, { "name": "assignees", "value": "", "type": "query" }, { "name": "sources", "value": "", "type": "query" }, { "name": "affected_services", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get last incidents" }, { "info": { "name": "Create Incident", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create new incident" }, { "info": { "name": "Get Incidents Meta", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents/meta", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get incidents' metadata for filtering" }, { "info": { "name": "Get Incident", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents/:incident_id", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get incident by id" }, { "info": { "name": "Update Incident", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/incidents/:incident_id", "params": [ { "name": "incident_id", "value": "", "type": "path" }, { "name": "generatedByAi", "value": "", "type": "query", "description": "Whether the incident update request was generated by AI" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update incident by id" }, { "info": { "name": "Delete Incident", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/incidents/:incident_id", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete incident by incident id" }, { "info": { "name": "Merge Incidents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/merge", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Merge incidents" }, { "info": { "name": "Get Incident Alerts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents/:incident_id/alerts", "params": [ { "name": "incident_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "include_unlinked", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get incident alerts by incident incident id" }, { "info": { "name": "Add Alerts To Incident", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/:incident_id/alerts", "params": [ { "name": "incident_id", "value": "", "type": "path" }, { "name": "is_created_by_ai", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Add alerts to incident" }, { "info": { "name": "Delete Alerts From Incident", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/incidents/:incident_id/alerts", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete alerts from incident" }, { "info": { "name": "Get Future Incidents For An Incident", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents/:incident_id/future_incidents", "params": [ { "name": "incident_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get same incidents linked to this one" }, { "info": { "name": "Get Incident Workflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incidents/:incident_id/workflows", "params": [ { "name": "incident_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get incident workflows by incident id" }, { "info": { "name": "Receive Event", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/event/:provider_type", "params": [ { "name": "provider_type", "value": "", "type": "path" }, { "name": "provider_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Receive an alert event from a provider" }, { "info": { "name": "Change Incident Status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/:incident_id/status", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Change incident status" }, { "info": { "name": "Add Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/:incident_id/comment", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Add incident audit activity" }, { "info": { "name": "Create With Ai", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/ai/suggest", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create incident with AI" }, { "info": { "name": "Commit With Ai", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/ai/:suggestion_id/commit", "params": [ { "name": "suggestion_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Commit incidents with AI and user feedback" }, { "info": { "name": "Confirm Incident", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/incidents/:incident_id/confirm", "params": [ { "name": "incident_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Confirm predicted incident by id" } ] }, { "info": { "name": "settings", "type": "folder" }, "items": [ { "info": { "name": "Webhook Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/webhook", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get details about the webhook endpoint (e.g. the API url and an API key)" }, { "info": { "name": "Get Smtp Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/smtp", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get SMTP settings" }, { "info": { "name": "Update Smtp Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/smtp", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Install or update SMTP settings" }, { "info": { "name": "Delete Smtp Settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/smtp", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete SMTP settings" }, { "info": { "name": "Test Smtp Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/smtp/test", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Test SMTP settings" }, { "info": { "name": "Create Key", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/settings/apikey", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create API key" }, { "info": { "name": "Update Api Key", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/settings/apikey", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update API key secret" }, { "info": { "name": "Get Keys", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/apikeys", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get API keys" }, { "info": { "name": "Delete Api Key", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/settings/apikey/:keyId", "params": [ { "name": "keyId", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete API key" }, { "info": { "name": "Get Sso Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/settings/sso", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Sso Settings" } ] }, { "info": { "name": "workflows", "type": "folder" }, "items": [ { "info": { "name": "Get Workflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows", "params": [ { "name": "is_v2", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get workflows" }, { "info": { "name": "Create Workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create or update a workflow" }, { "info": { "name": "Export Workflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/export", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "export all workflow Yamls" }, { "info": { "name": "Run Workflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/:workflow_id/run", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Run a workflow" }, { "info": { "name": "Run Workflow From Definition", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/test", "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Test run a workflow from a definition" }, { "info": { "name": "Create Workflow From Body", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflows/json", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create or update a workflow" }, { "info": { "name": "Get Random Workflow Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/random-templates", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get random workflow templates" }, { "info": { "name": "Get Workflow By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get workflow by ID" }, { "info": { "name": "Update Workflow By Id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update a workflow" }, { "info": { "name": "Delete Workflow By Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/workflows/:workflow_id", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete workflow" }, { "info": { "name": "Get Raw Workflow By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id/raw", "params": [ { "name": "workflow_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get workflow executions by ID" }, { "info": { "name": "Get Workflow Executions By Alert Fingerprint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/executions", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get workflow executions by alert fingerprint" }, { "info": { "name": "Get Workflow By Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id/runs", "params": [ { "name": "workflow_id", "value": "", "type": "path" }, { "name": "tab", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "trigger", "value": "", "type": "query" }, { "name": "execution_id", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get workflow executions by ID" }, { "info": { "name": "Get Workflow Execution Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflows/:workflow_id/runs/:workflow_execution_id", "params": [ { "name": "workflow_execution_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get a workflow execution status" } ] }, { "info": { "name": "whoami", "type": "folder" }, "items": [ { "info": { "name": "Get Tenant Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/whoami", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get tenant id" } ] }, { "info": { "name": "pusher", "type": "folder" }, "items": [ { "info": { "name": "Pusher Authentication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/pusher/auth", "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Authenticate a user to a private channel\n\nArgs:\n request (Request): The request object\n tenant_id (str, optional): The tenant ID. Defaults to Depends(verify_bearer_token).\n pusher_client (Pusher, optional): Pusher client. Defaults to Depends(get_pusher_client).\n\nRaises:\n HTTPException: 403 if the user is not allowed to access the channel.\n\nReturns:\n dict: The authentication response." } ] }, { "info": { "name": "status", "type": "folder" }, "items": [ { "info": { "name": "Status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/status" }, "docs": "simple status endpoint" } ] }, { "info": { "name": "rules", "type": "folder" }, "items": [ { "info": { "name": "Get Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/rules", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Rules" }, { "info": { "name": "Create Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/rules", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create Rule" }, { "info": { "name": "Update Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update Rule" }, { "info": { "name": "Delete Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/rules/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete Rule" } ] }, { "info": { "name": "preset", "type": "folder" }, "items": [ { "info": { "name": "Get Presets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/preset", "params": [ { "name": "time_stamp", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all presets for tenant" }, { "info": { "name": "Create Preset", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/preset", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a preset for tenant" }, { "info": { "name": "Update Preset", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/preset/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update a preset for tenant" }, { "info": { "name": "Delete Preset", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/preset/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a preset for tenant" }, { "info": { "name": "Get Preset Alerts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/preset/:preset_name/alerts", "params": [ { "name": "preset_name", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get the alerts of a preset" }, { "info": { "name": "Create Preset Tab", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/preset/:preset_id/tab", "params": [ { "name": "preset_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a tab for a preset" }, { "info": { "name": "Delete Tab", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/preset/:preset_id/tab/:tab_id", "params": [ { "name": "preset_id", "value": "", "type": "path" }, { "name": "tab_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a tab from a preset" } ] }, { "info": { "name": "enrichment", "type": "folder" }, "items": [ { "info": { "name": "Get Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/mapping", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all mapping rules" }, { "info": { "name": "Create Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/mapping", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a new mapping rule" }, { "info": { "name": "Update Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/mapping/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update an existing rule" }, { "info": { "name": "Delete Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/mapping/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a mapping rule" }, { "info": { "name": "Get Extraction Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/extraction", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all extraction rules" }, { "info": { "name": "Create Extraction Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/extraction", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a new extraction rule" }, { "info": { "name": "Update Extraction Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/extraction/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update an existing extraction rule" }, { "info": { "name": "Delete Extraction Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/extraction/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete an extraction rule" } ] }, { "info": { "name": "auth", "type": "folder" }, "items": [ { "info": { "name": "Get Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth/groups", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all groups" }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a group" }, { "info": { "name": "Update Group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/auth/groups/:group_name", "params": [ { "name": "group_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update a group" }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/auth/groups/:group_name", "params": [ { "name": "group_name", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a group" }, { "info": { "name": "Get Permissions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth/permissions", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get resources permissions" }, { "info": { "name": "Create Permissions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/permissions", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create permissions for resources" }, { "info": { "name": "Get Scopes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth/permissions/scopes", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all resources types" }, { "info": { "name": "Get Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth/roles", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get roles" }, { "info": { "name": "Create Role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/roles", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create role" }, { "info": { "name": "Update Role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/auth/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update role" }, { "info": { "name": "Delete Role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/auth/roles/:role_id", "params": [ { "name": "role_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete role" }, { "info": { "name": "Get Users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/auth/users", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all users" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auth/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a user" }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/auth/users/:user_email", "params": [ { "name": "user_email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update a user" }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/auth/users/:user_email", "params": [ { "name": "user_email", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a user" } ] }, { "info": { "name": "metrics", "type": "folder" }, "items": [ { "info": { "name": "Get Metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/metrics", "params": [ { "name": "labels", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "This endpoint is used by Prometheus to scrape such metrics from the application:\n- alerts_total {incident_name, incident_id} - The total number of alerts per incident.\n- open_incidents_total - The total number of open incidents.\n- workflows_executions_total {status} - The total number of workflow executions.\n\nPlease note that those metrics are per-tenant and are not designed to be used for the monitoring of the application itself.\n\nExample prometheus configuration:\n```\nscrape_configs:\n- job_name" } ] }, { "info": { "name": "dashboard", "type": "folder" }, "items": [ { "info": { "name": "Read Dashboards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Read Dashboards" }, { "info": { "name": "Create Dashboard", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dashboard", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create Dashboard" }, { "info": { "name": "Update Dashboard", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/dashboard/:dashboard_id", "params": [ { "name": "dashboard_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update Dashboard" }, { "info": { "name": "Delete Dashboard", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dashboard/:dashboard_id", "params": [ { "name": "dashboard_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete Dashboard" }, { "info": { "name": "Get Metric Widgets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dashboard/metric-widgets", "params": [ { "name": "mttr", "value": "", "type": "query" }, { "name": "apd", "value": "", "type": "query" }, { "name": "ipd", "value": "", "type": "query" }, { "name": "wpd", "value": "", "type": "query" }, { "name": "time_stamp", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Metric Widgets" } ] }, { "info": { "name": "tags", "type": "folder" }, "items": [ { "info": { "name": "Get Tags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/tags", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "get tags" } ] }, { "info": { "name": "maintenance", "type": "folder" }, "items": [ { "info": { "name": "Get Maintenance Rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/maintenance", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all maintenance rules" }, { "info": { "name": "Create Maintenance Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/maintenance", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a new maintenance rule" }, { "info": { "name": "Update Maintenance Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/maintenance/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update an existing maintenance rule" }, { "info": { "name": "Delete Maintenance Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/maintenance/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete a maintenance rule" } ] }, { "info": { "name": "topology", "type": "folder" }, "items": [ { "info": { "name": "Get Topology Data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topology", "params": [ { "name": "provider_ids", "value": "", "type": "query" }, { "name": "services", "value": "", "type": "query" }, { "name": "environment", "value": "", "type": "query" }, { "name": "include_empty_deps", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all topology data" }, { "info": { "name": "Get Applications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/topology/applications", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get all applications" }, { "info": { "name": "Create Application", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/topology/applications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create a new application" }, { "info": { "name": "Update Application", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/topology/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update an application" }, { "info": { "name": "Delete Application", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/topology/applications/:application_id", "params": [ { "name": "application_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete an application" } ] }, { "info": { "name": "deduplications", "type": "folder" }, "items": [ { "info": { "name": "Get Deduplications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deduplications", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Deduplications" }, { "info": { "name": "Create Deduplication Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/deduplications", "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Create Deduplication Rule" }, { "info": { "name": "Get Deduplication Fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/deduplications/fields", "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Get Optional Fields For Deduplications" }, { "info": { "name": "Update Deduplication Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/deduplications/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Update Deduplication Rule" }, { "info": { "name": "Delete Deduplication Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/deduplications/:rule_id", "params": [ { "name": "rule_id", "value": "", "type": "path" } ], "auth": { "type": "apikey", "key": "X-API-KEY", "value": "{{X-API-KEY}}", "placement": "header" } }, "docs": "Delete Deduplication Rule" } ] } ], "bundled": true }