How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Moogsoft Workflow Engine API

This API enables you to create and manage workflows

Moogsoft Workflow Engine API is one of 17 APIs that Moogsoft publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AIOps, Incident Management, standalone-workflows, Test Workflows, and workflow-dependent-on. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 17 operations across 13 paths, organized into 5 resource areas, and defines 42 schemas. It is described by OpenAPI 3.1.0, at version 1.3.0.

Requests are made against 2 base URLs: https://api.moogsoft.ai, https://api.dev.moogsoft.cloud.

17 operations 13 paths 42 schemas 1 DELETE9 GET4 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.3.0
Base URL
https://api.moogsoft.ai
Authentication
API Key
Terms of Service
Resource Areas
5

Authentication & Security 1

Moogsoft Workflow Engine API declares 1 security scheme for authenticating requests. An API key is passed in the header as apiKey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API Key for accessing Workflow Engine API

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 1 DELETE, 9 GET, 4 PATCH, 3 POST. They span 5 resource areas: test-workflows, workflows, workflow-dependent-on, standalone-workflows, workflow-actions. Each is listed below with its method, path, parameters, and response codes.

test-workflows 2

Synchronous workflow testing

POST
/v1/test-workflows/bulk
Test multiple workflows synchronously.
testWorkflows body → 2004004044XX5XX
POST
/v1/test-workflows
Test a workflow synchronously.
testWorkflow body → 2004004044XX5XX
workflows 12

Workflows for processing and transformation

GET
/v1/workflows/{id}/metrics/exceptions
Returns the exceptions for the specified workflow.
getWorkflowMetricsExceptions 1 param → 2004004044XX5XX
PATCH
/v1/workflows-bulk
Modifies workflows.
modifyWorkflows body → 2004004044XX5XX
PATCH
/v1/workflows/{id}
Modifies a workflow.
modifyWorkflow 1 param body → 2004004044XX5XX
GET
/v1/workflows/{id}
Returns the workflow with the given ID.
getWorkflow 2 params → 2004004044XX5XX
DELETE
/v1/workflows/{id}
Deletes the workflow with the given ID.
deleteWorkflow 1 param → 2044004044XX5XX
PATCH
/v1/workflows/{id}/status
Modifies the status for a specific workflow.
setWorkflowStatus 1 param body → 2004004044XX5XX
GET
/v1/workflows/{id}/status
Returns the status for a specific workflow.
getWorkflowStatus 1 param → 2004004044XX5XX
GET
/v1/workflows/{id}/metrics
Returns the metrics for the workflow with the given ID.
getWorkflowMetrics 1 param → 2004004044XX5XX
GET
/v1/workflows/{id}/test
Returns the result of the last async test run.
getWorkflowTest 1 param → 2004004044XX5XX
PATCH
/v1/workflows-bulk/priority
Modifies the priority for multiple workflows.
setWorkflowPriorities body → 2044004044XX5XX
GET
/v1/workflows
Returns all workflows.
getWorkflows 4 params → 2004004044XX5XX
POST
/v1/workflows
Creates a new workflow.
createWorkflow body → 2004004044XX5XX
workflow-dependent-on 1

Resources associated with workflows

GET
/v1/workflows-dependent-on
Retrieve workflows dependent on resource
getWorkflowsDependentOnResource 2 params → 2004004044XX5XX
standalone-workflows 1

Information about independently invokable workflows.

GET
/v1/standalone-workflows/usage
Get Workflow Usage By Id
getWorkflowUsageById 1 param → 2004004044XX5XX
workflow-actions 1

Actions available for use in workflows

GET
/v1/workflow-actions
Returns all possible actions for use in workflows.
getActions 1 param → 2004004044XX5XX

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are WorkflowDto (15 properties), WorkflowMetricsDto (13 properties), WorkflowTestResultDto (11 properties), ActionTestDto (9 properties). Each schema is shown below with its type and property counts.

BulkTestWorkflowDto
object
A bulk test workflow representing multiple workflows and test inputs.
3 properties 3 required
WorkflowTriggerType
string
WorkflowDto
object
Workflow with base and generated attributes.
15 properties 5 required
WorkflowTriggerDto
object
The trigger definition for a workflow.
2 properties 1 required
WorkflowType
string
WorkflowActionDto
object
A configured action.
5 properties 2 required
WorkflowStatus
string
WorkflowMetricsDto
object
Metrics about a running workflow.
13 properties
FilterMetricsDto
object
Metrics about a running filter.
7 properties
ActionMetricsDto
object
Metrics about a running action.
8 properties
WorkflowTestResultDto
object
Test results for a workflow.
11 properties
WorkflowTestStatus
string
FilterTestDto
object
Test results for a filter.
5 properties
ActionTestDto
object
Test results for an action.
9 properties
Instant
number
MoogResponseListOfBulkTestWorkflowResultsDto
object
Workflow Engine API BulkTestWorkflowResultsDto response body
2 properties 2 required
BulkTestWorkflowResultsDto
object
A bulk test workflow results.
2 properties
MoogFailureResponse
object
Workflow Engine API failure response body
3 properties 2 required
MoogErrorResponse
object
Workflow Engine API error response body
3 properties 2 required
MoogResponseWorkflowMetricsExceptionWrapperDto
object
Workflow Engine API WorkflowMetricsExceptionWrapperDto response body
2 properties 2 required
WorkflowMetricsExceptionWrapperDto
object
An object containing just the workflow exception information.
4 properties
WorkflowTestWrapperDto
object
A test workflow representing a workflow and test input.
8 properties 6 required
MoogResponseWorkflowTestResultDto
object
Workflow Engine API WorkflowTestResultDto response body
2 properties 2 required
WorkflowUpdateWrapperDto
object
Workflow update workflow attributes.
7 properties 6 required
MoogResponseListOfWorkflowDto
object
Workflow Engine API WorkflowDto response body
2 properties 2 required
ResourceType
Representing different types of resources used by workflow action
MoogResponseListOfWorkflowDependentOnResponseDto
object
Workflow Engine API WorkflowDependentOnResponseDto response body
2 properties 2 required
WorkflowDependentOnResponseDto
object
Response DTO used to represent workflow that is dependent on resources
3 properties
BaseWorkflowDto
object
Base workflow attributes.
6 properties 5 required
MoogResponseWorkflowDto
object
Workflow Engine API WorkflowDto response body
2 properties 2 required
WorkflowStatusWrapperDto
object
An object containing just the workflow status.
1 property 1 required
MoogResponseWorkflowStatusWrapperDto
object
Workflow Engine API WorkflowStatusWrapperDto response body
2 properties 2 required
MoogResponseWorkflowMetricsDto
object
Workflow Engine API WorkflowMetricsDto response body
2 properties 2 required
MoogResponseListOfStandaloneWorkflowUsageInfo
object
Workflow Engine API StandaloneWorkflowUsageInfo response body
2 properties 2 required
StandaloneWorkflowUsageInfo
object
Information about where a given standalone workflow is used.
4 properties
NameIdPair
object
2 properties
MoogResponseListOfActionDto
object
Workflow Engine API ActionDto response body
2 properties 2 required
ActionDto
object
Definition of a workflow action.
5 properties
ActionConfigurationSchemaDto
object
A list of schema for all the fields of an action.
1 property 1 required
ActionConfigurationFieldSchemaDto
object
Schema for a field of an action.
4 properties
WorkflowPriorityWrapperDto
object
Workflow update workflow priority.
2 properties 2 required
WorkflowCreateWrapperDto
object
Workflow create workflow attributes.
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

moogsoft-workflow-engine-service-openapi.yaml Raw ↑

Other APIs Moogsoft publishes across the network.

Moogsoft Alerts/Incidents API
Moogsoft Azure Application Insights API
Moogsoft Create Your Own Integration API
Moogsoft Amazon CloudWatch API
Moogsoft Collector V2 API
Moogsoft Config API
Moogsoft Events Integration API
Moogsoft On-Call API
Moogsoft Rollup Service API
Moogsoft Metrics API
Moogsoft PagerDuty Integration API
Moogsoft Probable Root Cause API
Where this information came from

This is an independent, third-party profile of Moogsoft Workflow Engine API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.