Opsient API Documentation

Opsient — Intelligent Incident Management Platform. This specification lists all available API endpoints.

Version 2.0.0 — Base URL: https://opsient.tarserv.com — OpenAPI JSON

MethodPathTagSummaryAuth
POST/api/auth/registerAuthRegister a new user accountPublic
POST/api/auth/verify-emailAuthVerify email address with tokenPublic
POST/api/auth/forgot-passwordAuthRequest password reset emailPublic
POST/api/auth/reset-passwordAuthReset password with tokenPublic
POST/api/auth/loginAuthAuthenticate and receive JWT tokenPublic
GET/api/auth/meAuthGet current authenticated user profileBearer
POST/api/auth/change-passwordAuthChange password for authenticated userBearer
GET/api/incidentsIncidentsList incidents (scoped to organization)Bearer
POST/api/incidentsIncidentsCreate a new incidentBearer
GET/api/incidents/searchIncidentsSearch incidents with filtersBearer
GET/api/incidents/exportIncidentsExport incidents (CSV or JSON)Bearer
GET/api/incidents/{id}IncidentsGet incident by IDBearer
POST/api/incidents/{id}/acknowledgeIncidentsAcknowledge an incidentBearer
POST/api/incidents/{id}/statusIncidentsUpdate incident status (investigating/mitigating)Bearer
POST/api/incidents/{id}/escalateIncidentsEscalate an incidentBearer
POST/api/incidents/{id}/resolveIncidentsResolve an incidentBearer
POST/api/incidents/{id}/pir/generateIncidentsAuto-generate a post-incident reviewBearer
POST/api/incidents/{id}/timelineIncidentsAdd a timeline entry to an incidentBearer
GET/api/incidents/{id}/ai/root-causeAIAI-powered root cause analysisBearer
GET/api/incidents/{id}/ai/summarizeAIAI-generated incident summaryBearer
GET/api/incidents/{id}/ai/similarAIFind similar past incidents using AIBearer
GET/api/runbooksRunbooksList all runbooksBearer
POST/api/runbooksRunbooksCreate a new runbookBearer
GET/api/runbooks/{id}RunbooksGet runbook by IDBearer
DELETE/api/runbooks/{id}RunbooksDelete a runbookBearer
POST/api/runbooks/{id}/executeRunbooksExecute a runbookBearer
GET/api/runbooks/executions/{id}RunbooksGet execution detailsBearer
GET/api/runbooks/{id}/executionsRunbooksList executions for a runbookBearer
GET/api/oncallOn-CallList all on-call schedulesBearer
GET/api/oncall/{team}On-CallGet on-call schedule for a teamBearer
GET/api/oncall/{team}/currentOn-CallGet current on-call person for a teamBearer
POST/api/oncall/{team}/overrideOn-CallCreate an on-call overrideBearer
DELETE/api/oncall/{team}/override/{userId}On-CallRemove an on-call overrideBearer
GET/api/alertsAlertsList alertsBearer
GET/api/alerts/statsAlertsGet alert statisticsBearer
POST/api/alerts/prometheusAlertsIngest Prometheus alertmanager webhookBearer
POST/api/alerts/grafanaAlertsIngest Grafana alert webhookBearer
POST/api/alerts/webhookAlertsIngest generic alert webhookBearer
GET/api/alert-rules/rulesAdvanced AlertsList alert rulesBearer
POST/api/alert-rules/rulesAdvanced AlertsCreate an alert ruleBearer
PUT/api/alert-rules/rules/{id}Advanced AlertsUpdate an alert ruleBearer
DELETE/api/alert-rules/rules/{id}Advanced AlertsDelete an alert ruleBearer
GET/api/alert-rules/silencesAdvanced AlertsList alert silencesBearer
POST/api/alert-rules/silencesAdvanced AlertsCreate an alert silenceBearer
DELETE/api/alert-rules/silences/{id}Advanced AlertsDelete an alert silenceBearer
GET/api/alert-rules/groupsAdvanced AlertsList alert groupsBearer
GET/api/statusStatusGet current system statusBearer
GET/api/status/historyStatusGet status page historyBearer
GET/api/analyticsAnalyticsGet incident analytics dashboard dataBearer
GET/api/analytics/mttrAnalyticsGet mean time to resolve metricsBearer
POST/api/chatbot/messageChatbotSend a message to the AI chatbotBearer
GET/api/chatbot/historyChatbotGet chatbot conversation historyBearer
GET/api/predictive/predictionsPredictiveList incident predictionsBearer
GET/api/predictive/anomaliesPredictiveList detected anomaliesBearer
GET/api/predictive/analysisPredictiveGet predictive analysis overviewBearer
GET/api/predictive/predictions/{id}PredictiveGet prediction by IDBearer
GET/api/predictive/anomalies/{id}PredictiveGet anomaly by IDBearer
GET/api/sla-contractsSLA ContractsList SLA contractsBearer
POST/api/sla-contractsSLA ContractsCreate an SLA contractBearer
GET/api/sla-contracts/{id}SLA ContractsGet SLA contract by IDBearer
PUT/api/sla-contracts/{id}SLA ContractsUpdate an SLA contractBearer
DELETE/api/sla-contracts/{id}SLA ContractsDelete an SLA contractBearer
GET/api/sla-contracts/{id}/complianceSLA ContractsGet SLA compliance statusBearer
GET/api/sla-contracts/{id}/reportSLA ContractsGenerate SLA compliance reportBearer
GET/api/changesChangesList change/deploy eventsBearer
POST/api/changesChangesRecord a change/deploy eventBearer
GET/api/changes/incidents/{id}ChangesGet changes related to an incidentBearer
GET/api/compliance/soc2ComplianceGenerate SOC 2 compliance reportBearer
GET/api/compliance/iso27001ComplianceGenerate ISO 27001 compliance reportBearer
GET/api/compliance/scoreComplianceGet overall compliance scoreBearer
GET/api/cost/incidents/{id}CostGet cost impact for an incidentBearer
GET/api/cost/monthlyCostGet monthly cost summaryBearer
GET/api/cost/servicesCostGet cost breakdown by serviceBearer
GET/api/metricsMetricsGet server and cluster metricsBearer
GET/api/metrics/liveMetricsGet live/real-time metricsBearer
GET/api/usersUsersList all usersBearer
POST/api/usersUsersCreate a new userBearer
GET/api/users/{id}UsersGet user by IDBearer
DELETE/api/users/{id}UsersDelete a userBearer
PUT/api/users/{id}/roleUsersUpdate user roleBearer
GET/api/users/{id}/permissionsUsersGet user permissionsBearer
GET/api/auditAuditList audit trail entriesBearer
GET/api/audit/{id}AuditGet audit entry by IDBearer
GET/api/pirPIRList post-incident reviewsBearer
GET/api/pir/{id}PIRGet post-incident review by IDBearer
GET/api/service-mapService MapGet service dependency mapBearer
GET/api/service-map/{id}/blast-radiusService MapGet blast radius for a serviceBearer
GET/api/service-map/{id}/healthService MapGet service health statusBearer
GET/api/war-roomsWar RoomsList active war roomsBearer
GET/api/war-rooms/{incidentId}War RoomsGet war room for an incidentBearer
POST/api/war-rooms/{incidentId}War RoomsCreate a war room for an incidentBearer
GET/api/war-rooms/{incidentId}/timelineWar RoomsGet war room timelineBearer
POST/api/war-rooms/{incidentId}/messagesWar RoomsPost a message in the war roomBearer
POST/api/war-rooms/{incidentId}/participantsWar RoomsAdd a participant to the war roomBearer
GET/api/maintenanceMaintenanceList maintenance windowsBearer
POST/api/maintenanceMaintenanceCreate a maintenance windowBearer
GET/api/maintenance/check/{serviceId}MaintenanceCheck if a service is in maintenanceBearer
GET/api/maintenance/{id}MaintenanceGet maintenance window by IDBearer
PUT/api/maintenance/{id}MaintenanceUpdate a maintenance windowBearer
DELETE/api/maintenance/{id}MaintenanceDelete a maintenance windowBearer
GET/api/tracesTracingSearch distributed tracesBearer
GET/api/traces/statsTracingGet tracing statisticsBearer
GET/api/traces/servicesTracingList traced servicesBearer
GET/api/traces/dependenciesTracingGet service dependency graph from tracesBearer
POST/api/traces/ingestTracingIngest trace spansBearer
GET/api/traces/{traceId}TracingGet trace by IDBearer
GET/api/logs/searchLogsSearch logs with filtersBearer
POST/api/logs/ingestLogsIngest log entriesBearer
GET/api/logs/statsLogsGet log statisticsBearer
GET/api/logs/tailLogsTail live log streamBearer
GET/api/logs/trace/{traceId}LogsGet logs for a traceBearer
POST/api/logs/lokiLogsIngest logs via Loki-compatible endpointBearer
POST/api/logs/fluentdLogsIngest logs via Fluentd-compatible endpointBearer
GET/api/infrastructure/hostsInfrastructureList monitored hostsBearer
GET/api/infrastructure/hosts/{id}/metricsInfrastructureGet metrics for a hostBearer
GET/api/infrastructure/containersInfrastructureList containersBearer
GET/api/infrastructure/k8s/podsInfrastructureList Kubernetes podsBearer
GET/api/infrastructure/k8s/nodesInfrastructureList Kubernetes nodesBearer
GET/api/infrastructure/k8s/deploymentsInfrastructureList Kubernetes deploymentsBearer
GET/api/infrastructure/k8s/summaryInfrastructureGet Kubernetes cluster summaryBearer
GET/api/infrastructure/prometheusInfrastructurePrometheus metrics endpointBearer
GET/api/integrationsIntegrationsList configured integrationsBearer
GET/api/integrations/statsIntegrationsGet integration statisticsBearer
GET/api/integrations/events/recentIntegrationsGet recent integration eventsBearer
GET/api/integrations/{id}IntegrationsGet integration by IDBearer
POST/api/integrations/{id}/toggleIntegrationsEnable or disable an integrationBearer
POST/api/integrations/{id}/testIntegrationsTest an integration connectionBearer
POST/api/integrations/{id}/queryIntegrationsQuery data from an integrationBearer
PUT/api/integrations/{id}/configIntegrationsUpdate integration configurationBearer
GET/api/integrations/{id}/eventsIntegrationsGet events for an integrationBearer
GET/api/itsmITSMList ITSM ticketsBearer
POST/api/itsmITSMCreate an ITSM ticketBearer
GET/api/itsm/statsITSMGet ITSM statisticsBearer
GET/api/itsm/incident/{incidentId}ITSMGet ITSM tickets for an incidentBearer
POST/api/itsm/{id}/syncITSMSync an ITSM ticketBearer
GET/api/data-retention/policiesData RetentionList data retention policiesBearer
PUT/api/data-retention/policies/{id}Data RetentionUpdate a retention policyBearer
POST/api/data-retention/purgeData RetentionTrigger data purgeBearer
GET/api/data-retention/storageData RetentionGet storage usageBearer
GET/api/sso/providersSSOList SSO providersBearer
POST/api/sso/providersSSOCreate an SSO providerBearer
GET/api/sso/providers/{id}SSOGet SSO provider by IDBearer
PUT/api/sso/providers/{id}SSOUpdate an SSO providerBearer
DELETE/api/sso/providers/{id}SSODelete an SSO providerBearer
GET/api/sso/api-keysSSOList API keysBearer
POST/api/sso/api-keysSSOCreate an API keyBearer
DELETE/api/sso/api-keys/{id}SSORevoke an API keyBearer
GET/api/rum/vitalsRUMGet Core Web VitalsBearer
GET/api/rum/performanceRUMGet page performance dataBearer
GET/api/rum/sessionsRUMList user sessionsBearer
GET/api/rum/errorsRUMList frontend errorsBearer
GET/api/rum/browsersRUMGet browser usage breakdownBearer
GET/api/rum/realtimeRUMGet real-time RUM dataBearer
GET/api/rum/statsRUMGet RUM statistics summaryBearer
GET/api/dashboardsDashboardsList dashboardsBearer
POST/api/dashboardsDashboardsCreate a dashboardBearer
GET/api/dashboards/{id}DashboardsGet dashboard by IDBearer
PUT/api/dashboards/{id}DashboardsUpdate a dashboardBearer
DELETE/api/dashboards/{id}DashboardsDelete a dashboardBearer
POST/api/dashboards/{id}/widgetsDashboardsAdd a widget to a dashboardBearer
PUT/api/dashboards/{id}/widgets/{widgetId}DashboardsUpdate a dashboard widgetBearer
DELETE/api/dashboards/{id}/widgets/{widgetId}DashboardsDelete a dashboard widgetBearer
POST/api/push/subscribePushSubscribe to push notificationsBearer
DELETE/api/push/subscribe/{id}PushUnsubscribe from push notificationsBearer
POST/api/push/testPushSend a test push notificationBearer
GET/api/push/subscriptionsPushList push subscriptionsBearer
GET/api/btBusiness TransactionsList business transactionsBearer
GET/api/bt/tiersBusiness TransactionsGet application tiersBearer
GET/api/bt/healthBusiness TransactionsGet business transaction healthBearer
GET/api/bt/slowBusiness TransactionsList slow transactionsBearer
GET/api/bt/errorsBusiness TransactionsList transaction errorsBearer
GET/api/bt/flowBusiness TransactionsGet transaction flow mapBearer
GET/api/bt/baselinesBusiness TransactionsGet performance baselinesBearer
GET/api/bt/{id}Business TransactionsGet business transaction by IDBearer
GET/api/bt/{id}/snapshotsBusiness TransactionsGet transaction snapshotsBearer
GET/api/workflowsWorkflowsList automation workflowsBearer
POST/api/workflowsWorkflowsCreate a workflowBearer
GET/api/workflows/{id}WorkflowsGet workflow by IDBearer
PUT/api/workflows/{id}WorkflowsUpdate a workflowBearer
DELETE/api/workflows/{id}WorkflowsDelete a workflowBearer
POST/api/workflows/{id}/toggleWorkflowsEnable or disable a workflowBearer
POST/api/workflows/{id}/executeWorkflowsExecute a workflow manuallyBearer
GET/api/workflows/{id}/executionsWorkflowsList workflow executionsBearer
GET/api/custom-metrics/definitionsCustom MetricsList custom metric definitionsBearer
POST/api/custom-metrics/definitionsCustom MetricsCreate a custom metric definitionBearer
GET/api/custom-metrics/definitions/{id}Custom MetricsGet custom metric definition by IDBearer
PUT/api/custom-metrics/definitions/{id}Custom MetricsUpdate a custom metric definitionBearer
DELETE/api/custom-metrics/definitions/{id}Custom MetricsDelete a custom metric definitionBearer
POST/api/custom-metrics/ingestCustom MetricsIngest custom metric data pointsBearer
GET/api/custom-metrics/query/{id}Custom MetricsQuery custom metric data by definition IDBearer
GET/api/custom-metrics/queryCustom MetricsQuery custom metrics with filtersBearer
GET/api/custom-metrics/summaryCustom MetricsGet custom metrics summaryBearer
GET/api/custom-metrics/latest/{id}Custom MetricsGet latest data point for a custom metricBearer
GET/api/billing/plansBillingList available billing plansPublic
POST/api/billing/webhookBillingStripe webhook endpointPublic
GET/api/billing/subscriptionBillingGet current subscriptionBearer
POST/api/billing/checkoutBillingCreate Stripe checkout sessionBearer
POST/api/billing/cancelBillingCancel subscriptionBearer
GET/api/billing/usageBillingGet current plan usage and limitsBearer
POST/api/webhooks/githubWebhooksGitHub webhook receiverPublic
POST/api/webhooks/jenkinsWebhooksJenkins webhook receiverPublic
POST/api/webhooks/sentryWebhooksSentry webhook receiverPublic
POST/api/webhooks/terraformWebhooksTerraform webhook receiverPublic
POST/api/webhooks/datadogWebhooksDatadog webhook receiverPublic
POST/api/webhooks/slackWebhooksSlack webhook receiverPublic
POST/api/webhooks/genericWebhooksGeneric webhook receiverPublic