JUMP TOMoogsoft APIsWelcome to the Moogsoft Cloud APIs!Request requirementsResponsesAuthenticationUser roles and permissionsManage API keysReferencesAPI License and DisclaimerAlerts/Incidents APIAlert API ObjectAlerts API OverviewFilter alertsIncidents API OverviewIncidents API ObjectAlert Columns Resource V 2Get column names of alert DTO.getincident columns resourceGet column names of IncidentDTO.getGet V1 column names of IncidentDTO.getreindexGet ALL existing alerts from RDS and insert them to the ES indicespostGet ALL existing incidents from RDS and insert them to the ES indicespostReturns status of reindex operationgetGet existing alerts happened within the given time window and insert them to the ES indicespostReindex specified alert from RDS to ES/OSpostGet existing incidents happened within the given time window and insert them to the ES indicespostReindex specified incident from RDS to ES/OSpostalertsGet details associated with specific external system.getAdd externalID information to an alert.postDelete externalID information to an alert.deleteAdd externalID information to an alert.patchGet all externalIds associated with the alert.getGet a list of all alerts with matching criteria.getGet a list of all alerts with matching criteria.postUpdate the "status" or "owner" field in multiple alerts.patchGet details of the alert with the specified ID.getUpdate the "status" or "owner" field in a specific alert.patchalert-filters/v1/alert-filters/{userId}get/v1/alert-filters/{userId}/{filterId}get/v1/alert-filters/{userId}/{filterId}put/v1/alert-filters/{userId}/{filterId}delete/v1/alert-filters/validatepostincident-filters/v1/incident-filters/{userId}/{filterId}get/v1/incident-filters/{userId}/{filterId}put/v1/incident-filters/{userId}/{filterId}delete/v1/incident-filters/{userId}get/v1/incident-filters/validatepostincident-commentsDelete comment of an incidentdeleteupdate existing commentpatchGet all comments of an existing incidentgetAdd comment to existing incidentpostautomation-configGet automation config for auto close of alerts and incidents.getUpdate automation config for auto close of alerts and incidents.patchworkflow-inputsReturns inputs previously seen at the input of workflow engine.getincident history resourceReturns incident/alert history for the listed incidents or alertsgetalerts-searchSearch for alerts, given namespace and eventTimegetincidentsGet incident by id.getUpdate the incident to the given status and/or assignee.putUpdate the incident to the given status and/or assignee.patchList incidents that match the given filter.getGet a list of all incidents with matching criteria.postUpdate multiple incidents to the given status and/or assignee.patchGet all externalIds associated with the incident.getGet details associated with specific external system.getAdd externalID information to an incident.postDelete externalID information from an incident.deleteUpdate externalID information to an incident.patchGet timeline for an incidentgettest-workflowsTest multiple workflows synchronously.postTest a workflow synchronously.postincident-tags-configGet tags config for incidents.getUpdate tags config for incidents.patchAPIAzure AppInsights API OverviewAzure AppInsights API Objectappinsightsgets an AppInsights integrationgetdeletes an AppInsights integrationdeleteUpdate an existing integrationpatchTests the matching credential set in the credential storepostGets all AppInsights IntegrationsgetCreates a new AppInsights integrationpostMoogsoft Cloudwatch APIAmazon CloudWatch API OverviewcloudwatchGet cloudwatch detector configurationgetUpdate cloudwatch detector configurationpostDelete a cloudwatch integrationdeleteUpdate a cloudwatch integrationpatchStatus for a cloudwatch integrationgetGet Moogsoft AWS accountIDgetTest cloudwatch credentialspostList all existing cloudwatch integrationsgetCreate a new cloudwatch integrationpostCollector V2 APICollector v2 API ObjectCollectors API Overviewcollector-installerReturns the base URL for api requests.getCheck if the collector service is activeheadReturns a command to download and install the collector.getDownload the collector bundle.getFetch the latest collector version as JSON.getFetch the collector install script.getCollector Upgrade Schedules ResourceGet the collector upgrade schedule(s).getUpdate the collector upgrade schedule.patchcollectorsGet all known collectors.getRegister/update a collector and set up default plugins.postGet a collector by id.get/v2/collectors/{collectorId}deleteGet a new API Key for an id.get/v2/collectors/{collectorId}/encrypted-topologyget/v2/collectors/{collectorId}/heartbeatspost/v2/collectors/{collectorId}/logsget/v2/collectors/{collectorId}/logspost/v2/collectors/{collectorId}/messagesget/v2/collectors/{collectorId}/messagespost/v2/collectors/{collectorId}/messages/{messageId}patchmanual-collector-configReturns any manual collector config that matches.getCreate new manual collector config.postDelete all matching manual collector config.deleteGet the manual collector config with the given id.getDelete the manual collector config with the given id.deleteplugin-configUpdate the plugin config with the given id.patchReturns any plugin config that matches.getCreate new plugin config.postDelete all matching plugin config with the given collector id.deleteGet the plugin config with the given id.getDelete the plugin config with the given id.deleteUpdate the plugin config with the given id.patchpluginsGet all the plugins.getGet the named plugin.getproduct-feedback/v2/product-feedbackpostConfig APICatalogs API OverviewCatalog API ObjectCatalog Document API ObjectCredential Store APIMaintenance Windows API OverviewMaintenance Window CREATE Request ExampleValid Time Zones for Maintenance WindowscatalogsReturns all catalogs.getCreates a new, empty catalog.postReturns catalog settings.getReturns the catalog with the given id.getDeletes the catalog and content documents (by catalog id).deleteAdds a batch of new documents to the catalog.postReturns the matching documents in the catalog.getAdds a new document (row) to the catalog.postReturns a document from the catalog.getDeletes a single document in a catalog (by catalog id).deleteModifies a document in the catalog.patchReturns the matching documents in the catalog.postDeletes a single document in a catalog (by catalog name).deleteModifies a document in the catalog.patchCreates a new catalog with schema and documents based on the given CSV file.postReturns the matching documents in the catalog.getAdds a new document (row) to the catalog.postReturns the catalog with the given name.getDeletes the catalog and content documents (by catalog name).deleteReturns the matching documents in the catalog.postReturns all catalogs.getCreates a new, empty catalog.postAdds a batch of new documents to the catalog.postconfigSearch for matching config/credential(s).getReturns credentials for the supplied parameters.getCreate new credentials.postDelete credentials.deleteUpdate credentials.patchBulk delete credentials.deleteSearch for matching credential.getBulk delete config.deleteSearch for matching config.getReturns config for the supplied parameters.getCreate a new config.postDelete config.deleteUpdate config.patchmaintenance windowsCancels an existing maintenance window schedule.putGets multiple maintenance window occurrences for a specific maintenance window (EXPIRED only).getGets maintenance window occurrences that have expired or been skipped or cancelled (in reverse time order)getGets an existing maintenance occurrence.getGets multiple maintenance window occurrences for a specific maintenance window (PENDING only).getGets maintenance window occurrences that are runninggetGets an existing maintenance window's current status.getSkips an existing maintenance window schedule.putGets multiple maintenance window occurrences for a specific maintenance window (RUNNING only).getGets multiple maintenance window schedules.getCreates a new maintenance window schedule.postGets maintenance window occurrences that are pendinggetGets multiple maintenance window occurrences for a specific maintenance window (all statuses).getGets an existing maintenance window schedule.getDeletes an existing maintenance window schedule.deleteUpdates an existing maintenance window schedule.patchGet all available timezones.getCorrelation Definitions Management APICorrelation API ObjectCorrelations API Overviewcorrelation-groupsFetches all correlation groups.getCreates a new correlation group record.postFetches the correlation group identified in the path parameter (either the id or the name).getDeletes the correlation group identified in the path parameter (either the id or the name).deleteEdits the correlation group identified in the path parameter (either the id or the name).patchFetches the correlation group identified in the path parameter (either the id or the name).getDeletes the correlation group identified in the path parameter (either the id or the name).deleteEdits the correlation group identified in the path parameter (either the id or the name).patchcorrelation-definitionsFetches correlation definition matching the identifier in the path parameter (either the id or the name).getDeletes the correlation definition identified in the path parameter (either the id or the name).deleteEdits the correlation definition identified in the path parameter (either the id or the name).patchFetches correlation definition matching the identifier in the path parameter (either the id or the name).getDeletes the correlation definition identified in the path parameter (either the id or the name).deleteEdits the correlation definition identified in the path parameter (either the id or the name).patchFetches all correlation definitions.getCreates a new correlation definition record.postCreate Your Own Integration APICreate Your Own Integration API OverviewCustom Integration API Mapping Config ObjectCustom Integration API Endpoint Objectcustom-integration-configsGets the draft config for a particular endpointgetUpdates the draft config for an endpointputGets the live config for a particular endpointgetUpdates the live config for an endpointputTests the provided config for an endpoint against a provided series of json payloadspostcustom-integration-trafficGet a specific payload sent to an endpointgetGet a summary of traffic volume and outcomes for a custom endpointgetGet recent payloads sent to an endpointgetcustom-integration-error-logsReads custom endpoint processing errors from the DB.getDeletes custom endpoint processing errors from the DB.deletecustom-integration-endpointsGet all configured custom endpointsgetCreate new custom endpointpostGet a custom endpointgetUpdate a custom endpointputDelete a custom endpointdeletePost payload to a custom endpointpostPost payload to a custom endpointpostbyoapi-integration-endpointsGet all configured integrations endpointsgetDatadog Integration APIDatadog Integration API ObjectDatadog Integration API OverviewdatadogGets all Datadog hosts, metrics, tags and associated sourcesgetGets validation requests and responses from Datadog metrics and events api callspostgets a datadog integrationgetdeletes a datadog integrationdeleteUpdate an existing integrationpatchTests the matching credential set in the credential storepostGets all Datadog IntegrationsgetCreates a new datadog integrationpostEvents IntegrationEvents Integration API OverviewEvents API Objecttest-workflowsTest multiple workflows synchronously.postTest a workflow synchronously.postevent-columnsget columns names of Event DTOgetevents-integrationPost event(s) to MOC.postworkflow-inputsReturns inputs previously seen at the input of workflow engine.getMetrics APIMetrics Integration API OverviewMetric Datum API ObjectAnomaly Detection API ObjectpoliciesGet a specific policy by its idgetDelete an existing policydeletePatch an existing policypatchGet the metric policiesgetCreate a new policypostPatch existing policiespatchSearch for policies that apply to a given time seriespostModifies the priority for multiple policies.patchmetricsProcess metrics from the Telegraf JSON formatpostCreate one or more metricspostCreate one or more metricspostdetectorsGet the detector config for an integration and metricgetUpdate the detector config for an integration and a metricpostGet the detector config for a specific integration and metricgetPager Duty APIPagerDuty Integration API OverviewPagerDuty Integration API Objectpagerduty-testTest a PagerDuty integrationpostpagerdutyList PagerDuty integrationsgetCreate a PagerDuty integrationpostGet a PagerDuty integrationgetDelete a PagerDuty integrationdeleteUpdate a PagerDuty integrationpatchRollup Service APIRollups API OverviewRollup ResourceGet a series of metric rollups in time order based on the input filtersgetDatums ResourceGet a series of datums in time order based to the input filtersgetGet a series of datums in time order based on the input filtersgetDatum Indexes ResourceGet a series of datums in time order based to the input filters.getGet a series of datums in time order based to the input filters (POST because filter can be very long)postPrometheus Proxy Resource/v1/tsdb/seriesget/v1/tsdb/query_rangeget/v1/tsdb/label/{name}/valuesget/v1/tsdb/queryget/v1/tsdb/check_syntaxget/v1/tsdb/labelsgetDatum Index Suggestions ResourceGet possible autocomplete suggestions for the particular field and valuegetAnomalies Resource/v1/anomaliespostAnomaly Metrics Resource/v1/anomaly-metricsgetUser APIUsers and Keys API OverviewUser API ObjectAPI Key ObjectGroupsList User GroupsgetCreate a User GrouppostGet a User GroupgetDelete a User GroupdeleteUpdate a User GrouppatchRolesGet all roles in the systemgetCreate a new roles in the systempostGet specific role detailsgetDelete a custom role in the systemdeleteUpdate a role in the systempatchSSOGet a callback url for OIDC authenticationgetGet SSO connection detailsgetCreate an auth0 connectionpostEdit SSO connectionpatchDisable an SSO connectionputEnable an SSO connectionputUserGet all users in the systemgetCreate a new userpostGet details for an existing usergetDelete a user in the systemdeleteEdit an existing userpatchApikeys-usersGet an API keys for an usergetCreate a new API keypostGet details for specific API keygetDelete an API key associated with a userdeletepermissionsGET all permissionsgetApikeysGet all API keys in the systemgetDelete API keys in the systemdeleteWebhook APIOutbound Integrations API OverviewOutbound Integration API ObjectOutbound Webhooks API OverviewwebhooksV2Reads webhooks from the DB.getPost and process webhook config to the DB.postGet webhook config from the DB.getUpdate webhook config to the DB.putDelete webhook config from the DB.deletePatch webhook config to the DB.patchPreview a webhook.postTest a webhook.postwebhooksV2 LogsReads webhook logs from the DB.getDeletes webhook logs from the DB.deletewebhooksV2 MetricsReads webhook metrics from the DB.getDeletes webhook metrics from the DB.deleteWorkflow Engine APIWorkflow API ObjectWorkflow Metrics ObjectWorkflow Engine API Overviewtest-workflowsTest multiple workflows synchronously.postTest a workflow synchronously.postworkflowsReturns the exceptions for the specified workflow.getModifies workflows.patchReturns the workflow with the given ID.getDeletes the workflow with the given ID.deleteModifies a workflow.patchReturns the status for a specific workflow.getModifies the status for a specific workflow.patchReturns the metrics for the workflow with the given ID.getReturns the result of the last async test run.getModifies the priority for multiple workflows.patchReturns all workflows.getCreates a new workflow.postworkflow-inputsReturns inputs previously seen at the input of workflow engine.getworkflow-actionsReturns all possible actions for use in workflows.getworkflow-templatesReturns all template actions.getCreates a new template action.postDeletes the template action with the given ID.deleteModifies the template action.patchGets maintenance window occurrences that have expired or been skipped or cancelled (in reverse time order)get https://api.moogsoft.ai/v1/maintenance/occurrences/expired
