Managing Flows in a Cluster Using REST APIs
The management console provides REST APIs that you can use to programmatically access much of the console’s functionality. Among the operations that you can request with the REST APIs are operations related to managing flows in a cluster. This includes finding flows in a cluster, as well as starting and stopping a flow’s endpoints.
| See Using the Management Console APIs for an overview of the REST APIs, including a basic example of use, and a summary of returned status codes and error handling codes. |
This page provides a brief description of each REST API for managing flows in a cluster, an HTTP method to invoke the API, and a usage example. The examples show how to invoke the API using cURL, the command line HTTP tool.
Note: The notation \{mmc base} refers to the console base address. The console base address used in the examples is http://localhost:8080/mmc and configured with the default username and password (admin:admin).
The table below summarizes the REST APIs for managing deployments:
| Task | Resource | Description | HTTP Invocation Method |
|---|---|---|---|
Get Flows |
\{mmc base}/api/clusters/<cluster>/flows |
Lists all flows in a cluster |
GET |
Get Flow Endpoints |
\{mmc base}/api/clusters/<cluster>/flows/<flowName>/<application>/endpoints |
Lists all endpoints for a flow |
GET |
Start or Stop Endpoints |
\{mmc base}/api/clusters/<cluster>/flows/<flowName>/<applicationName>/endpoints/<endpointId>/start (or stop) |
Starts (or stops) an endpoint for a flow |
POST |
Start or Stop a Flow |
\{mmc base}/api/clusters/<cluster>/flows/<flowName>/<applicationName>/start (or stop) |
Starts or stops a flow |
POST |
All examples on this page use the cluster and data as shown below:
{
"data": [
{
"clusterStatus": "OK",
"deployments": [],
"groupIds": [],
"id": "fb044ee2-f097-43e1-8e1f-4b446f703cac",
"lastRestarted": 1314982582819,
"location": "N/A",
"name": "ClusterXY",
"nodeServerIds": [
"local$191630af-3cfa-4535-87f8-420f7eb03c0f",
"local$2364843f-dd47-4556-97e0-105e0011ee2d"
],
"nodesUpCount": 2,
"pausedServices": 0,
"runningServices": 0,
"status": "2 of 2 nodes online",
"stoppedServices": 0,
"totalServices": 0,
"version": "3.2.0-RC3"
}
],
"total": 1
}Get Flows
Lists all the flows in a cluster.
HTTP Method:
GET
URL:
http://{mmc base}/api/clusters/{cluster}/flowsParameters:
cluster: The name or ID of a cluster for the listed flows.
Example:
The following example shows how to list the flows for a cluster with an ID of fb044ee2-f097-43e1-8e1f-4b446f703cac:
Request:
curl --basic -u admin:admin http://localhost:8080/mmc/api/clusters/ClusterXY/flowsJSON Response:
{
"data": [
{
"asyncEventsReceived": 0,
"auditStatus": "DISABLED",
"averageProcessingTime": -1,
"executionErrors": 0,
"fatalErrors": 0,
"favorite": false,
"flowId": {
"application": "mule-example-echo-3.2.0-RC3",
"definedInApplication": true,
"fullName": "EchoFlow [mule-example-echo-3.2.0-RC3]",
"name": "EchoFlow"
},
"id": "fb044ee2-f097-43e1-8e1f-4b446f703cac/EchoFlow",
"inboundEndpoints": [
"http://localhost:65082/services/EchoUMO"
],
"maxProcessingTime": 0,
"minProcessingTime": 0,
"processedEvents": 0,
"clusterId": "fb044ee2-f097-43e1-8e1f-4b446f703cac",
"status": "RUNNING",
"syncEventsReceived": 0,
"totalEventsReceived": 0,
"totalProcessingTime": 0,
"type": "flow"
}
],
"total": 1
}Get Flow Endpoints
Lists all endpoints for a flow.
HTTP Method:
GET
URL:
{mmc base}/api/clusters/{cluster}/flows/{flowName}/{applicationName}/endpointsParameters:
-
cluster: The ID of the cluster.
-
applicationName: The application name of the flow.
-
flowName: The name of the flow.
Example:
The following example shows how to list the endpoints for a flow named EchoFlow, whose application name is test-app, in the cluster whose ID is fb044ee2-f097-43e1-8e1f-4b446f703cac:
Request:
curl --basic -u admin:admin http://localhost:8080/mmc/api/clusters/ClusterXY/flows/EchoFlow/test-app/endpointsJSON Response:
{
"data": [
{
"address": "http://localhost:65082/services/EchoUMO",
"connector": "connector.http.mule.default",
"filtered": false,
"id": "endpoint.http.localhost.65082.services.EchoUMO",
"routedMessages": 0,
"status": "started",
"synchronous": true,
"tx": false,
"type": "http"
}
],
"total": 1
}Start/Stop Endpoints
Start or Stop an endpoint for a specified flow.
HTTP Method:
POST
URL:
Start:
http://{mmc base}/clusters/{cluster}/flows/{flowName}/{applicationName}/endpoints/{endpointId}/startStop:
http://{mmc base}/clusters/{cluster}/flows/{flowName}/{applicationName}/endpoints/{endpointId}/stopParameters:
-
cluster: The name or ID of a cluster.
-
applicationName: The application name of the flow.
-
flowName: The name of the flow name.
-
endpointId: The name of an endpoint to be started or stopped.
Example:
Request:
Start an endpoint:
curl --basic -u admin:admin -X POST http://localhost:8080/mmc/api/clusters/ClusterXY/flows/EchoFlow/test-app/endpoints/endpoint.http.localhost.65082.services.EchoUMO/startStop an endpoint:
curl --basic -u admin:admin -X POST http://localhost:8080/mmc/api/clusters/ClusterXY/flows/EchoFlow/test-app/endpoints/endpoint.http.localhost.65082.services.EchoUMO/stopJSON Response:
A list of endpoints that have been successfully started or stopped.
["endpoint.http.localhost.65082.services.EchoUMO"]Start/Stop a Flow
Starts or stops a flow in a cluster.
HTTP Method:
POST
URL:
Start:
http://{mmc base}/api/clusters/{cluster}/flows/{flowName}/{applicationName}/startStop:
http://{mmc base}/api/clusters/{cluster}/flows/{flowName}/{applicationName}/stopParameters:
-
cluster: The name or ID of a cluster.
-
applicationName: The application name of the flow.
-
flowName: The name of the flow.
Example:
Request:
Start a flow:
curl --basic -u admin:admin -X POST http://localhost:8080/mmc/api/clusters/ClusterXY/flows/EchoFlow/test-app/startStop a flow:
url --basic -u admin:admin -X POST http://localhost:8080/mmc/api/clusters/ClusterXY/flows/EchoFlow/test-app/stopResponse:
The flow started or stopped successfully